@vnodes/graphql
    Preparing search index...

    Type Alias SubscriptionOptions<T>

    SubscriptionOptions: BaseTypeOptions<T> & {
        deprecationReason?: string;
        description?: string;
        filter?: (
            payload: any,
            variables: any,
            context: any,
        ) => boolean | Promise<boolean>;
        name?: string;
        resolve?: (
            payload: any,
            args: any,
            context: any,
            info: any,
        ) => any | Promise<any>;
    }

    Interface defining options that can be passed to @Subscription() decorator.

    Type Parameters

    • T = any

    Type Declaration

    • OptionaldeprecationReason?: string

      Subscription deprecation reason (if deprecated).

    • Optionaldescription?: string

      Description of the subscription.

    • Optionalfilter?: (payload: any, variables: any, context: any) => boolean | Promise<boolean>

      Filter messages function.

    • Optionalname?: string

      Name of the subscription.

    • Optionalresolve?: (payload: any, args: any, context: any, info: any) => any | Promise<any>

      Resolve messages function (to transform payload/message shape).

    Settings

    Member Visibility