Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Poller<TState, TResult>

Package version

Type parameters

  • TState

  • TResult

Hierarchy

  • Poller

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns Poller

Properties

Protected operation

operation: PollOperation<TState, TResult>

Methods

cancelOperation

  • cancelOperation(options?: undefined | object): Promise<void>

  • Parameters

    • Optional options: undefined | object

    Returns Promise<void>

Protected Abstract delay

  • delay(): Promise<void>

  • Returns Promise<void>

getOperationState

getResult

  • getResult(): TResult | undefined

  • Returns TResult | undefined

isDone

  • isDone(): boolean

  • Returns boolean

isStopped

  • isStopped(): boolean

  • Returns boolean

onProgress

  • Parameters

    • callback: function
        • (state: TState): void

        • Parameters

          • state: TState

          Returns void

    Returns CancelOnProgress

poll

  • poll(options?: undefined | object): Promise<void>

  • Parameters

    • Optional options: undefined | object

    Returns Promise<void>

pollUntilDone

  • pollUntilDone(): Promise<TResult>

  • Returns Promise<TResult>

stopPolling

  • stopPolling(): void

toString

  • toString(): string

  • Returns string

Generated using TypeDoc