API index and search · Build metadata

Supporting declarations

packages/remote/src/subscribe.ts. These declarations explain referenced types. Only package-page symbols are package exports.

Exact source

export type SubscribeMode = "flat" | "normalized";

export interface SubscribeRequest {
    queryId: QueryId;
    remote: RemoteQuery;
    mode: SubscribeMode;
}

export type SubscribeTarget = {
    name: string;
    args: unknown;
    leaseToken?: never;
    wsEndpoint?: never;
} | {
    leaseToken: string;
    wsEndpoint?: string;
    name?: never;
    args?: never;
};

export type SubscribeResolver = (request: SubscribeRequest) => SubscribeTarget | PromiseLike<SubscribeTarget>;

export type RawMutationSender = (mutations: Mutation[]) => void | PromiseLike<void>;

export type MutationEnvelopeSender = (envelope: MutationEnvelope) => void | PromiseLike<void>;

export declare function defaultSubscribeTarget(request: SubscribeRequest): SubscribeTarget;

export declare function subscribeMessage(request: SubscribeRequest, target: SubscribeTarget): SubscribeClientMsg;

export declare function isThenable<T>(value: T | PromiseLike<T>): value is PromiseLike<T>;