named-app-errors

This package exports a set of "named" (i.e. in the stack trace) error classes (extending the Error class) with TypeScript support. The output of these errors provides better DX than normal since the error type's name is included when toString() is called.

This package includes TypeScript types and provides:

• A UMD/CJS/AMD bundle (no tree-shaking)
• ES2015 modules (tree-shaking)

Install

npm install named-app-errors

Usage

When creating your own error classes, you should subclass AppError and call the special makeNamedError method afterwards like so:

import { AppError, makeNamedError } from 'named-app-errors'

export class CustomSpecialError extends AppError {
    constructor(message?: string) {
        super(message ?? 'something important failed');
    }
}

makeNamedError(CustomSpecialError, 'CustomSpecialError');

It might seem redundant to supply both the class object and a class name string, but it is necessary for the shiny new error name to survive minification.

Afterwards, you can use your error class like so:

import { AppError, CustomSpecialError } from 'named-app-errors'

try {
    // ...
    throw new CustomSpecialError();
    // ...
}

catch(e) {
    if(e instanceof AppError)
        console.error(e) // ==> "CustomSpecialError: something important failed"

    else
        throw e;
}

Type Glossary

This library provides the following types:

• AppError
• GuruMeditationError
• HookError
• FetchError
• NotAuthorizedError
• NotFoundError
• KeyTypeError
• ValidationError

AppError

AppError(message?: string, fileName?: string, lineNumber?: number)

An AppError indicates an error generic application error. Direct descendant of Error with the same constructor and no additional functionality. This class is meant to be used as an application-wide base error class, which makes it useful for stuff like instanceof checks in catch blocks (so that we're only handling our application's errors).

import { AppError } from 'named-app-errors'

throw new AppError();

GuruMeditationError

GuruMeditationError(message?: string)

A GuruMeditationError indicates the occurrence of a supposedly impossible runtime condition. Usually requires the assistance of a guru to debug efficiently. Scary!

import { AppError } GuruMeditationError 'named-app-errors'

throw new GuruMeditationError();

HookError

HookError(message?: string)

A HookError indicates an error during React Hook execution.

import { HookError } from 'named-app-errors'

throw new HookError();

FetchError

FetchError(res: Response, error?: string)

A FetchError indicates an error while attempting to fetch an HTTP resource.

import { FetchError } from 'named-app-errors'

throw new FetchError();

NotAuthorizedError

NotAuthorizedError(message?: string)

A NotAuthorizedError indicates the operation failed due to lack of authorization.

import { AppError NotAuthorizedError from 'named-app-errors'

throw new NotAuthorizedError();

NotFoundError

NotFoundError(reference?: T)

A NotFoundError indicates the operation failed because the subject was not found.

import { NotFoundError } from 'named-app-errors'

throw new NotFoundError();

KeyTypeError

KeyTypeError()

A KeyTypeError indicates an error handling a key (invalid, bad, etc). This error does not reveal any additional information about the key or the error for security reasons.

import { KeyTypeError } from 'named-app-errors'

throw new KeyTypeError();

ValidationError

ValidationError(message?: string)

A ValidationError indicates an error during validation.

import { ValidationError } from 'named-app-errors'

throw new ValidationError();

Contributing

Issues and pull requests are welcome! In lieu of a formal styleguide, take care to maintain the existing coding style.

Add unit tests for any new or changed functionality. Please lint and test your code!

Release History

• 1.0.x Initial release