Class BlipError

A BlipError is an error constructed with special considerations for HTTP clients.

A BlipError is safe for public APIs by default. It will not expose any sensitive information used directly.

See

inspection for remarks on using the error for inspection on server-side.

Hierarchy

  • BlipBase
    • BlipError

Constructors

constructor

Properties

_rootErr data err inspection message name server stack statusCode prepareStackTrace? stackTraceLimit

Accessors

code inspect log originalStack rootErr status

Methods

[custom] captureStackTrace

Constructors

constructor

  • Creates a new BlipError.

    Parameters

    • Optional message: string

      The error message.

    • Optional options: BlipOptions

      An object containing options for the error.

    Returns BlipError

Properties

Readonly Internal _rootErr

_rootErr: undefined | Error

For internal use - use rootErr instead.

Readonly data

data: undefined | object

Metadata associated with the error.

See

BlipOptions

Private Readonly err

err: {
    message: string;
    statusCode: number;
}

Type declaration

  • message: string
  • statusCode: number

Readonly inspection

inspection: BlipInspectionError

A special representation of BlipError that can be inspected by the console or used in custom logging solutions.

See

BlipInspectionError for more information and remarks.

Readonly message

message: string

A message associated with the error.

Default Value

''

Remarks

This is designed to be public-facing.

Readonly name

name: "BlipError" = 'BlipError'

Name of the Error - always 'BlipError'.

Readonly server

server: boolean

truthy when the error is a server error (status code >= 500), otherwise falsy.

Readonly stack

stack: undefined | string

Stack trace associated with the Error.

Default Value

The default is the stack trace of rootErr if provided in BlipOptions, otherwise the stack trace of the BlipError which is automatically generated.

Readonly statusCode

statusCode: number

HTTP Status code associated with the error.

See

BlipOptions

Static Optional prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

code

  • get code(): number

  • Alias for statusCode.

    Alias

    statusCode

    Returns number

inspect

log

originalStack

  • get originalStack(): undefined | string

  • Used to obtain the original stack when a rootErr was provided. (If a rootErr.stack is present, it will take the place of the BlipError stack).

    Returns undefined | string

rootErr

  • get rootErr(): undefined | Error

  • Returns the root error that caused this error, if one was provided as BlipOptions' rootErr.

    Returns undefined | Error

status

  • get status(): number

  • Alias for statusCode.

    Alias

    statusCode

    Returns number

Methods

Private [custom]

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc