Class default<T, TPreviousResult>

Encapsulates a value allowing for returning an envelope that contains the possible outcomes of a method.

Type Parameters

  • T = Record<string, unknown>

  • TPreviousResult extends IResultBase = never

Hierarchy

  • default

Implements

Constructors

constructor

Properties

#error? #previousResult? #success #value?

Accessors

error previousResult success value

Methods

fail ok

Constructors

constructor

  • Type Parameters

    • T = Record<string, unknown>

    • TPreviousResult extends IResultBase<never, TPreviousResult> = never

    Parameters

    • success: boolean
    • Optional value: T
    • Optional error: string
    • Optional previousResult: TPreviousResult

    Returns default<T, TPreviousResult>

Properties

Private Optional Readonly #error

#error?: string

Private Optional Readonly #previousResult

#previousResult?: TPreviousResult

Private Readonly #success

#success: boolean

Private Optional Readonly #value

#value?: T

Accessors

error

previousResult

success

value

Methods

Static fail

  • Type Parameters

    • T

    • TPreviousResult extends IResultBase<never, TPreviousResult> = never

    Parameters

    • Optional error: string
    • Optional value: T
    • Optional previousResult: TPreviousResult

    Returns IResult<T, TPreviousResult>

Static ok

  • Type Parameters

    • T

    • TPreviousResult extends IResultBase<never, TPreviousResult> = never

    Parameters

    • Optional value: T
    • Optional previousResult: TPreviousResult

    Returns IResult<T, TPreviousResult>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc