Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseErrorFactory<T>

BaseErrorFactory

BaseErrorFactory is factory for errors, that all other error factories inherit from. It provides error class registration and global error context.

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

BaseError

BaseError: T = BaseError as any

context

context: Object

Methods

defineErrorClass

  • defineErrorClass<T>(error: T): T
  • Defines a new error class on ErrorFactory

    example

    class MyErrorFactory extends BaseErrorFactory { MyError = this.defineErrorClass( class MyError extends this.BaseError {} ); }

    const factory = new MyErrorFactory();

    throw new factory.MyError('some_error_code');

    Type parameters

    Parameters

    • error: T

    Returns T

withContext

  • withContext<F>(this: F, context?: Object): F
  • Creates new error factory with global error context that is avalible on all errors defined on returned error factory.

    example

    class MyErrorFactory extends BaseErrorFactory { MyError = this.defineErrorClass( class MyError extends this.BaseError {} ); }

    const contextualErrorFactory = new MyErrorFactory().withContext({ userId: '123-123' });

    const error = new contextualErrorFactory.MyError('some_error_code');

    error.context; // {userId: '123-123'}

    Type parameters

    Parameters

    • this: F
    • Default value context: Object = {}

    Returns F

Generated using TypeDoc