!npm !npm !Snyk Vulnerabilities for npm package !NPM

Unify errors

A simple library to normalize typescript standard errors. Feel free to create pull request to define new errors ! Old Owner: @flexper

Usage

``typescript
import { BadRequest } from 'unify-errors';

function errorExample() {
throw new BadRequest({
context: "Example context"
});
}
`

API

$3

Return: CustomError with Bad Request message.

$3

Return: CustomError with Unauthorized message.

$3

Return: CustomError with Forbidden message.

$3

Return: CustomError with Not Found message.

$3

Return: CustomError with Request TimeOut message.

$3

Return: CustomError with Internal Server Error message.

$3

Return: CustomError with Not Implemented message.

$3

Return: CustomError with Too Many Requests message.

$3

The CustomError class extends the basic typescript Error class. It is used to create all custom errors.

Params

| Field Name | Type | Default | Description |
| ---------- | ------------------ | --------- | -------------------------------- |
| message | string | mandatory | Mandatory error message property |
| context | CustomErrorContext | {} | Optional record of string |

How to use

To create a new error type, create a new class extending CustomError inside the _errors_ folder.

Don't forget to export it from index.ts too

``typescript
import { CustomErrorContext } from '../types/CustomErrorContext';
import { CustomError } from './CustomError';


export class InternalServerError extends CustomError {
constructor(public context?: CustomErrorContext) {
super('Internal Server error', context);

// Set the prototype explicitly.
Object.setPrototypeOf(this, InternalServerError.prototype);
}
}

``

Tests

To execute jest tests (all errors, type integrity test)

`
pnpm test
``

Maintain

This package use TSdx. Please check documentation to update this package.