Catch the highlights of GraphQLConf 2023! Click for recordings. Or check out our recap blog post.
Documentation
Interfaces
server.Context

Interface: Context<P, E>

server.Context

Type parameters

NameType
Pextends ConnectionInitMessage["payload"] = ConnectionInitMessage["payload"]
Eunknown

Properties

acknowledged

Readonly acknowledged: boolean

Indicates that the connection was acknowledged by having dispatched the ConnectionAck message to the related client.

Defined in

src/server.ts:500


connectionInitReceived

Readonly connectionInitReceived: boolean

Indicates that the ConnectionInit message has been received by the server. If this is true, the client wont be kicked off after the wait timeout has passed.

Defined in

src/server.ts:494


connectionParams

Optional Readonly connectionParams: Readonly<P>

The parameters passed during the connection initialisation.

Defined in

src/server.ts:502


extra

extra: E

An extra field where you can store your own context values to pass between callbacks.

Defined in

src/server.ts:521


subscriptions

Readonly subscriptions: Record<string, null | AsyncGenerator<unknown, any, unknown> | AsyncIterable<unknown>>

Holds the active subscriptions for this context. All operations that are taking place are aggregated here. The user is subscribed to an operation when waiting for result(s).

If the subscription behind an ID is an AsyncIterator - the operation is streaming; on the contrary, if the subscription is null - it is simply a reservation, meaning - the operation resolves to a single result or is still pending/being prepared.

Defined in

src/server.ts:513