Package Exports

@typescript-error/core

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@typescript-error/core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@typescript-error/core ⛱

This is a library, which provides an abstract error class, which can be extended by specific implementations. It also defines a base error options schema, which can be extended pretty easy ⚡.

Table of Contents

Installation
Usage
Types

Installation

npm install @typescript-error/core --save

Usage

To use the BaseError class just import it.

import {BaseError, ErrorOptions} from "@typescript-error/core";

const options : ErrorOptions = {
    logMessage: true,
    logLevel: 'warning',
    code: 1,
    statusCode: 404,
    //... define some own options
    foo: 'bar'
}
const error = new BaseError('The entity could not be found', options);

// access the option values

const statusCode = error.getOption('statusCode');
console.log(statusCode);
// 404

const foo = error.getOption('foo');
console.log(foo);
// bar

Like demonstrated in the example above, predefined options keys can be set. In addition, own options, can also be defined ⚡.

Another good practice is to hide common error options under an own definition.

import {
    BaseError, 
    ErrorOptions,
    mergeErrorOptions
} from "@typescript-error/core";

export class NotFoundError extends BaseError {
    constructor(options?: ErrorOptions) {
        super(mergeErrorOptions(
            {
                logMessage: true,
                logLevel: 'warning',
                statusCode: 404,   
            },
            ...(options ? options : {})
        ));
    }

}

Types

ErrorOptions

export type ErrorOptions = {
    /**
     * The error code is either a short uppercase string identifier for the error or a numeric error code. For example: SERVER_ERROR
     */
    code?: string | number,
    /**
     * Mark this error as error which need to be logged.
     */
    logMessage?: boolean,
    /**
     * Set the log level for this error.
     */
    logLevel?: string | number,

    /**
     * Specify if the error message should be decorated for public view
     * or already provide a decoration message.
     */
    decorateMessage?: boolean | string,
    /**
     * Specify a previous error.
     */
    previous?: Error,
    /**
     * In case of a http error provide a numeric Status Code between 400-599.
     */
    statusCode?: number,
    /**
     * Specify a redirect URL in case of a http error.
     */
    redirectURL?: string,

    /**
     * Permit additional properties
     */
    [key: string]: any
}