Beignet API reference
    Preparing search index...
    interface RedisBroadcast {
        close(): Promise<void>;
        publish<
            C extends
                ChannelDefinition<
                    string,
                    StandardSchemaV1<unknown, Record<string, string>>,
                    Record<string, StandardSchemaV1<unknown, unknown>>,
                >,
        >(
            channel: C,
            publication: BroadcastPublication<C>,
        ): Promise<void>;
        start(): Promise<void>;
        subscribe<
            C extends
                ChannelDefinition<
                    string,
                    StandardSchemaV1<unknown, Record<string, string>>,
                    Record<string, StandardSchemaV1<unknown, unknown>>,
                >,
        >(
            channel: C,
            options: {
                onDisconnect: () => void;
                onEvent: (
                    event: InferChannelEvent<C>,
                    metadata: { excludeOrigin?: BroadcastOrigin },
                ) => void;
                params: InferChannelParams<C>;
            },
        ): BroadcastSubscription;
    }

    Hierarchy (View Summary)

    Index
    • Returns Promise<void>

    • Returns Promise<void>