Package version:

Interface PollerOptions<TState>

Options for long-running operations (pollers) in the Form Recognizer clients.

Type Parameters

Hierarchy

Properties

onProgress? resumeFrom? updateIntervalInMs?

Properties

Optional onProgress

onProgress?: ((state: TState) => void)

Type declaration

    • (state: TState): void

    • An optional initial progress handler that will be called when the poller state updates. This handler will be called once immediately after the poller state is initialized.

      Parameters

      • state: TState

      Returns void

Optional resumeFrom

resumeFrom?: string

A serialized poller state. If provided, the polling operation will be resumed from the given state instead of started as if it were a new operation.

Optional updateIntervalInMs

updateIntervalInMs?: number

The amount of time to wait (in milliseconds) between subsequent requests relating to the same operation.

Settings

Member Visibility

Theme

Generated using TypeDoc