Skip to main content

GraphQLWebSocketClient

@iota/graphql-transport

@iota/graphql-transport / GraphQLWebSocketClient

Class: GraphQLWebSocketClient

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

Constructors​

Constructor​

new GraphQLWebSocketClient(endpoint, options?): GraphQLWebSocketClient

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

Parameters​

endpoint​

string

options?​

GraphQLWebSocketClientOptions = {}

Returns​

GraphQLWebSocketClient

Methods​

close()​

close(): void

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

Returns​

void

send()​

send(message): Promise<WebSocket>

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

Parameters​

message​

ConnectionInitMessage | SubscribeMessage | CompleteMessage | PongMessage

Returns​

Promise<WebSocket>

subscribe()​

subscribe<T>(request): Promise<() => Promise<boolean>>

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

Type Parameters​

T​

T

Parameters​

request​

GraphQLSubscriptionRequest<T>

Returns​

Promise<() => Promise<boolean>>