Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PollerOptions<TState>

Package version

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

Type parameters

  • TState: PollOperationState<unknown>

Hierarchy

Index

Properties

Optional onProgress

onProgress: undefined | ((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.

Optional resumeFrom

resumeFrom: undefined | 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: undefined | number

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

Generated using TypeDoc