Skip to main content

IotaTransportSubscribeOptions

@iota/iota-sdk


@iota/iota-sdk / client / IotaTransportSubscribeOptions

Interface: IotaTransportSubscribeOptions<T>

Defined in: sdk/typescript/src/client/http-transport.ts:45

Type Parameters​

T​

T

Properties​

method​

method: string

Defined in: sdk/typescript/src/client/http-transport.ts:46


onError?​

optional onError?: (error) => void

Defined in: sdk/typescript/src/client/http-transport.ts:54

Called when the subscription ends without the caller unsubscribing. No further messages arrive after it, so a caller that wants to keep receiving must subscribe again.

Parameters​

error​

Error

Returns​

void


onMessage​

onMessage: (event) => void

Defined in: sdk/typescript/src/client/http-transport.ts:49

Parameters​

event​

T

Returns​

void


params​

params: unknown[]

Defined in: sdk/typescript/src/client/http-transport.ts:48


signal?​

optional signal?: AbortSignal

Defined in: sdk/typescript/src/client/http-transport.ts:55


startAfter?​

optional startAfter?: string

Defined in: sdk/typescript/src/client/http-transport.ts:56


unsubscribe​

unsubscribe: string

Defined in: sdk/typescript/src/client/http-transport.ts:47