Skip to main content
Version: 11.x

Type Alias: SubscriptionOptions

SubscriptionOptions = object

Defined in: src/channel/ws/subscription.ts:27

Options for creating a new Subscription instance

Properties​

channel​

channel: SubscriptionOwner

Defined in: src/channel/ws/subscription.ts:29

The channel that created this subscription and can end it

method​

method: string

Defined in: src/channel/ws/subscription.ts:31

The JSON-RPC method used to create this subscription

params?​

optional params?: object

Defined in: src/channel/ws/subscription.ts:33

The parameters used to create this subscription (optional, defaults to empty object)

id​

id: SUBSCRIPTION_ID

Defined in: src/channel/ws/subscription.ts:35

The unique identifier for this subscription

maxBufferSize​

maxBufferSize: number

Defined in: src/channel/ws/subscription.ts:37

The maximum number of events to buffer