Class GraphQLWebSocketClient<TTypings>

constructor

• new GraphQLWebSocketClient<TTypings>(options): GraphQLWebSocketClient<TTypings>

• Type Parameters

  • TTypings extends GraphQLWebSocketClientTypings = GraphQLWebSocketClientTypings

  Parameters

  • options: GraphQLWebSocketClientOptions<TTypings>

  Returns GraphQLWebSocketClient<TTypings>

OptionalgraphqlSocket

Readonlyprotocol

Readonlyurl

close

• close(code?, reason?): void

• Parameters

  • Optionalcode: number
  • Optionalreason: string

  Returns void

requireConnection

• requireConnection(): Promise<GraphQLClientWebSocket>

• Returns Promise<GraphQLClientWebSocket>

setConnectionInitPayload

• setConnectionInitPayload(connectionInitPayload): void

• Parameters

  • connectionInitPayload: Record<string, unknown>

  Returns void

shouldRetry

• shouldRetry(err): boolean

• Parameters

  • err: Error & {
        code?: number;
    }

  Returns boolean

subscribe

• subscribe<TData>(payload): AsyncPushIterator<ExecutionResult<TData, ObjMap<unknown>>>

• Type Parameters

  • TData

  Parameters

  • payload: {
        operationName?: null | string;
        query: string;
        variables?: null | Record<string, unknown>;
    }

    • OptionaloperationName?: null | string

    • query: string

    • Optionalvariables?: null | Record<string, unknown>

  Returns AsyncPushIterator<ExecutionResult<TData, ObjMap<unknown>>>

subscribeAsync

• subscribeAsync<TData>(payload, options): (() => void)

• Type Parameters

  • TData

  Parameters

  • payload: {
        operationName?: null | string;
        query: string;
        variables?: null | Record<string, unknown>;
    }

    • OptionaloperationName?: null | string

    • query: string

    • Optionalvariables?: null | Record<string, unknown>

  • options: {
        onData: ((data: TData) => unknown);
        onError: ((error: Error) => unknown);
    }

    • onData: ((data: TData) => unknown)

      • • (data): unknown

        • Parameters

          • data: TData

          Returns unknown

    • onError: ((error: Error) => unknown)

      • • (error): unknown

        • Parameters

          • error: Error

          Returns unknown

  Returns (() => void)

  • • (): void

    • Returns void

subscribeAsyncNamed

• subscribeAsyncNamed<TSubscriptionName>(operationName, variables, options): (() => void)

• Type Parameters

  • TSubscriptionName extends string

  Parameters

  • operationName: TSubscriptionName
  • variables: TTypings["OperationNameToVariables"][TSubscriptionName]
  • options: {
        onData: ((data: TTypings["OperationNameToData"][TSubscriptionName]) => unknown);
        onError: ((error: Error) => unknown);
    }

    • onData: ((data: TTypings["OperationNameToData"][TSubscriptionName]) => unknown)

      • • (data): unknown

        • Parameters

          • data: TTypings["OperationNameToData"][TSubscriptionName]

          Returns unknown

    • onError: ((error: Error) => unknown)

      • • (error): unknown

        • Parameters

          • error: Error

          Returns unknown

  Returns (() => void)

  • • (): void

    • Returns void

subscribeNamed

• subscribeNamed<TSubscriptionName>(operationName, variables): AsyncPushIterator<ExecutionResult<TTypings["OperationNameToData"][TSubscriptionName], ObjMap<unknown>>>

• Type Parameters

  • TSubscriptionName extends string

  Parameters

  • operationName: TSubscriptionName
  • variables: TTypings["OperationNameToVariables"][TSubscriptionName]

  Returns AsyncPushIterator<ExecutionResult<TTypings["OperationNameToData"][TSubscriptionName], ObjMap<unknown>>>