Skip to main content

GraphQLSubscriptionRequest

@iota/graphql-transport

@iota/graphql-transport / GraphQLSubscriptionRequest

Type Alias: GraphQLSubscriptionRequest<T>

GraphQLSubscriptionRequest<T> = object

Defined in: sdk/graphql-transport/src/graphql-websocket-client.ts:71

Type Parameters​

T​

T = any

Properties​

onComplete?​

optional onComplete?: () => void

Defined in: sdk/graphql-transport/src/graphql-websocket-client.ts:77

Returns​

void

onError?​

optional onError?: (errors) => void

Defined in: sdk/graphql-transport/src/graphql-websocket-client.ts:76

Parameters​

errors​

object[]

Returns​

void

onMessage​

onMessage: (data) => void

Defined in: sdk/graphql-transport/src/graphql-websocket-client.ts:75

Parameters​

data​

T

Returns​

void

query​

query: GraphQLDocument

Defined in: sdk/graphql-transport/src/graphql-websocket-client.ts:72

signal?​

optional signal?: AbortSignal

Defined in: sdk/graphql-transport/src/graphql-websocket-client.ts:78

variables?​

optional variables?: GraphQLSubscriptionVariables | (() => GraphQLSubscriptionVariables | undefined)

Defined in: sdk/graphql-transport/src/graphql-websocket-client.ts:74

Resolved on every send, so a resubscribe can carry a resume cursor.