Type Alias: SubscriptionOptions

SubscriptionOptions = object

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

Options for creating a new Subscription instance

Properties

channel

channel: WebSocketChannel

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

The containing WebSocketChannel instance

---

method

method: string

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

The JSON-RPC method used to create this subscription

---

params?

optional params?: object

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

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

---

id

id: SUBSCRIPTION_ID

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

The unique identifier for this subscription

---

maxBufferSize

maxBufferSize: number

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

The maximum number of events to buffer