Interface Successfully<TResult>

An indicator of successful supply cut off.

Type Parameters

  • out TResult = void

    Supply result type.

Hierarchy

Accessors

  • get error(): undefined
  • An error indicating supply failure reason.

    Contains value only when failed flag is true. Contains undefined value otherwise.

    Returns undefined

  • get failed(): false
  • Whether the supply has failed.

    When true, the error property contains a failure reason.

    Returns false

  • get isOff(): this
  • A reference to itself.

    Use to detect a supply cut off indicator.

    Returns this

  • get result(): TResult
  • A result of successfully completed supply.

    Contains value only when failed flag is false. Contains undefined otherwise.

    Returns TResult

Methods

  • Whether indicated cut off happened at the same time as another one.

    The supplies depending on the one cut off initially, considered cut off at the same time.

    Parameters

    • another: SupplyIsOff<unknown>

      Another cut off indicator.

    Returns boolean

Generated using TypeDoc