Type alias PollOptions<TIncludeTransactions, TBlockTag>

PollOptions<TIncludeTransactions, TBlockTag>: {
    blockTag?: TBlockTag | BlockTag;
    emitMissed?: boolean;
    emitOnBegin?: boolean;
    includeTransactions?: TIncludeTransactions;
    pollingInterval?: number;
}

Type Parameters

  • TIncludeTransactions extends boolean = false

  • TBlockTag extends BlockTag = "latest"

Type declaration

  • Optional blockTag?: TBlockTag | BlockTag

    The block tag. Defaults to "latest".

  • Optional emitMissed?: boolean

    Whether or not to emit the missed blocks to the callback.

  • Optional emitOnBegin?: boolean

    Whether or not to emit the block to the callback when the subscription opens.

  • Optional includeTransactions?: TIncludeTransactions

    Whether or not to include transaction data in the response.

  • Optional pollingInterval?: number

    Polling frequency (in ms). Defaults to the client's pollingInterval config.

Settings

Member Visibility

Theme

Generated using TypeDoc