Class Operations

Operations

Remarks

Operations represent the status and result of long running tasks performed by KERIA agent

Hierarchy

  • Operations

Constructors

Properties

Methods

Constructors

Properties

Methods

  • Delete operation

    Parameters

    • name: string

      Name of the operation

    Returns Promise<void>

    Async

  • Get operation status

    Type Parameters

    • T = unknown

    Parameters

    • name: string

      Name of the operation

    Returns Promise<Operation<T>>

    A promise to the status of the operation

    Async

  • List operations

    Parameters

    • Optional type: string

      Select operations by type

    Returns Promise<Operation<any>[]>

    A list of operations

    Async

  • Poll for operation to become completed.

    Type Parameters

    • T

    Parameters

    • op: Operation<T>
    • options: {
          increaseFactor?: number;
          maxSleep?: number;
          minSleep?: number;
          signal?: AbortSignal;
      } = {}
      • Optional increaseFactor?: number
      • Optional maxSleep?: number
      • Optional minSleep?: number
      • Optional signal?: AbortSignal

    Returns Promise<Operation<T>>

Generated using TypeDoc