Setu-TS
    Preparing search index...

    Interface PubSubOptions

    Options for GCP Pub/Sub broker.

    interface PubSubOptions {
        client?: IPubSubTransport;
        credentials?: unknown;
        defaultQueue?: string;
        enableMessageOrdering?: boolean;
        logger?: { error: (msg: string) => void };
        projectId?: string;
        publishTimeoutMs?: number;
        replyTopic?: string;
    }
    Index
    client? credentials? defaultQueue? enableMessageOrdering? logger? projectId? publishTimeoutMs? replyTopic?
    client?: IPubSubTransport

    Injected transport (bypasses lazy SDK load).

    credentials?: unknown

    Service-account credentials (object or key path). SDK ADC is used when omitted.

    defaultQueue?: string

    Default consumer-group subscription-name PREFIX (default 'messaging-consumers'). A subscription with no SubscribeOptions.queue uses <defaultQueue>.<topic ID>, one subscription per topic, because Pub/Sub subscription names are project-global (M101b).

    enableMessageOrdering?: boolean

    Create the transport's own subscriptions with message ordering enabled (default false), required before a native orderingKey is delivered in order. Fixed at subscription creation and it costs throughput, so it is opt-in (M106 §3.5). Refused together with client: an injected transport creates its own subscriptions, so pass the flag to adaptPubSubModule instead.

    logger?: { error: (msg: string) => void }

    Optional logger.

    projectId?: string

    GCP project ID. Required unless client is injected.

    publishTimeoutMs?: number

    Publish bound in ms, default 15000; 0 disables it. A timeout may still deliver.

    0.10.0

    replyTopic?: string

    Shared reply topic for request-reply (must pre-exist).

    Settings
    Member Visibility

    On This Page
    Properties