Skip to content

Error Class é uma biblioteca para ajudar a lançar novos erros com nomes, tipos e mensagens personalizadas

Notifications You must be signed in to change notification settings

Joao208/errors-stack

Repository files navigation

Errors stack

Sonarcloud Status codecov

A JavaScript error library to make easier, faster and practical the stack of errors.

Usage

BodyPropertyError

Throw this error if it is a body property error.

import { BodyPropertyError } from 'errors-stack';

throw new BodyPropertyError('message');

ForbiddenError

Throw this error if it is a forbidden error.

import { ForbiddenError } from 'errors-stack';

throw new ForbiddenError('message');

HealthError

Throw this error if it is a health error.

import { HealthError } from 'errors-stack';

throw new HealthError('message');

InternalServiceError

Throw this error if it is a internal server error.

import { InternalServiceError } from 'errors-stack';

throw new InternalServiceError('message');

NotFoundError

Throw this error if it is a not found error.

import { NotFoundError } from 'errors-stack';

throw new NotFoundError('message');

ParamPropertyError

Throw this error if it is a param error.

import { ParamPropertyError } from 'errors-stack';

throw new ParamPropertyError('message');

QueryPropertyError

Throw this error if it is a query error.

import { QueryPropertyError } from 'errors-stack';

throw new QueryPropertyError('message');

TooManyRequestsError

Throw this error if has many requests.

import { TooManyRequestsError } from 'errors-stack';

throw new TooManyRequestsError('message');

UnauthorizedError

Throw this error if has unauthorized situation.

import { UnauthorizedError } from 'errors-stack';

throw new UnauthorizedError({ message: 'message', status: 401 });

UnknownError

Throw this error if error is unknown.

import { UnknownError } from 'errors-stack';

throw new UnknownError({ message: 'message', status: 401 });

ValidationError

Throw this error if is an validation error, and array is necessary to throw this error.

import { ValidationError } from 'errors-stack';

throw new ValidationError({
  message: 'message',
  validations: [new BodyPropertyError('message')],
});

Personalized Errors

You can instance new error, with name and params and throw when is necessary

import { ErrorsStack } from 'errors-stack'

const MyError = ErrorsStack({
  name: 'MyError',
  message: 'My default message',
})

throw new MyError({
  message: 'My personalized message',
  status: 500,
  errorParams: { isAuthenticated: false },
})

License

errors-stack is freely distributable under the terms of MIT License.