graphql-ws/lib/message.d.ts

Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client

/**
 *
 * message
 *
 */
import { GraphQLError, ExecutionResult } from 'graphql';
import { ID } from './types';
/** Types of messages allowed to be sent by the client/server over the WS protocol. */
export declare enum MessageType {
    ConnectionInit = "connection_init",
    ConnectionAck = "connection_ack",
    Subscribe = "subscribe",
    Next = "next",
    Error = "error",
    Complete = "complete"
}
export interface ConnectionInitMessage {
    readonly type: MessageType.ConnectionInit;
    readonly payload?: Record<string, unknown>;
}
export interface ConnectionAckMessage {
    readonly type: MessageType.ConnectionAck;
    readonly payload?: Record<string, unknown>;
}
export interface SubscribeMessage {
    readonly id: ID;
    readonly type: MessageType.Subscribe;
    readonly payload: SubscribePayload;
}
export interface SubscribePayload {
    readonly operationName?: string | null;
    readonly query: string;
    readonly variables?: Record<string, unknown> | null;
}
export interface NextMessage {
    readonly id: ID;
    readonly type: MessageType.Next;
    readonly payload: ExecutionResult;
}
export interface ErrorMessage {
    readonly id: ID;
    readonly type: MessageType.Error;
    readonly payload: readonly GraphQLError[];
}
export interface CompleteMessage {
    readonly id: ID;
    readonly type: MessageType.Complete;
}
export declare type Message<T extends MessageType = MessageType> = T extends MessageType.ConnectionAck ? ConnectionAckMessage : T extends MessageType.ConnectionInit ? ConnectionInitMessage : T extends MessageType.Subscribe ? SubscribeMessage : T extends MessageType.Next ? NextMessage : T extends MessageType.Error ? ErrorMessage : T extends MessageType.Complete ? CompleteMessage : never;
/** Checks if the provided value is a message. */
export declare function isMessage(val: unknown): val is Message;
/** Parses the raw websocket message data to a valid message. */
export declare function parseMessage(data: unknown): Message;
/** Stringifies a valid message ready to be sent through the socket. */
export declare function stringifyMessage<T extends MessageType>(msg: Message<T>): string;