Class Error

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? BuildFailed ContainerAlreadyCreated NoContainer NoDockerfile NoDockerode NoImage NoName NoNameNorDockerfile NotDockerode PullFailed prepareStackTrace? stackTraceLimit

Methods

captureStackTrace define

Constructors

constructor

  • new Error(message?): Error

  • Parameters

    • Optional message: string

    Returns Error

  • new Error(message?, options?): Error

  • Parameters

    • Optional message: string
    • Optional options: ErrorOptions

    Returns Error

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static BuildFailed

BuildFailed: typeof OopsError = ...

Static ContainerAlreadyCreated

ContainerAlreadyCreated: typeof OopsError = ...

Static NoContainer

NoContainer: typeof OopsError = ...

Static NoDockerfile

NoDockerfile: typeof OopsError = ...

Static NoDockerode

NoDockerode: typeof OopsError = ...

Static NoImage

NoImage: typeof OopsError = ...

Static NoName

NoName: typeof OopsError = ...

Static NoNameNorDockerfile

NoNameNorDockerfile: typeof OopsError = ...

Static NotDockerode

NotDockerode: typeof OopsError = ...

Static PullFailed

PullFailed: typeof OopsError = ...

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static define

  • define<T>(name, getMessage?, construct?): typeof OopsError

  • Define an error subclass.

    Type Parameters

    • T extends unknown[]

    Parameters

    • name: string

      Name of error class. Prepended to parent.

    • getMessage: string | ((...args) => string) = ...

      How to generate the error message from the arguments passed to the constructor.

    • Optional construct: ((self, ...args) => any)

      Whether there are any further construction steps such as assigning properties.

        • (self, ...args): any

        • Parameters

          Returns any

    Returns typeof OopsError

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc