Interface StreamConfig

interface StreamConfig {
    appId?: string;
    batchSize?: number;
    maxRetries?: number;
    namespace?: string;
    nats?: {
        ackWait?: number;
        deliverPolicy?:
            | "all"
            | "last"
            | "new"
            | "byStartSequence"
            | "byStartTime";
        durableName?: string;
        jetstream?: boolean;
    };
    postgres?: {
        cleanupInterval?: number;
        enableNotifications?: boolean;
        notificationFallbackInterval?: number;
        notificationTimeout?: number;
        partitionInterval?: "daily" | "weekly" | "monthly";
        pollInterval?: number;
        vacuumInterval?: number;
    };
    provider?: StreamProviderType;
    retry?: RetryPolicy;
    securedWorker?: boolean;
    sqs?: {
        deadLetterQueue?: string;
        dlqArn?: string;
        messageRetentionPeriod?: number;
        visibilityTimeout?: number;
        waitTimeSeconds?: number;
    };
    timeout?: number;
}

Properties

appId? batchSize? maxRetries? namespace? nats? postgres? provider? retry? securedWorker? sqs? timeout?

Properties

OptionalappId

appId?: string

OptionalbatchSize

batchSize?: number

OptionalmaxRetries

maxRetries?: number

Optionalnamespace

namespace?: string

Optionalnats

nats?: {
    ackWait?: number;
    deliverPolicy?:
        | "all"
        | "last"
        | "new"
        | "byStartSequence"
        | "byStartTime";
    durableName?: string;
    jetstream?: boolean;
}

Optionalpostgres

postgres?: {
    cleanupInterval?: number;
    enableNotifications?: boolean;
    notificationFallbackInterval?: number;
    notificationTimeout?: number;
    partitionInterval?: "daily" | "weekly" | "monthly";
    pollInterval?: number;
    vacuumInterval?: number;
}

Optionalprovider

provider?: StreamProviderType

Optionalretry

retry?: RetryPolicy

Default retry policy for all streams in this app. Can be overridden per message using PublishMessageConfig.

Example

{
  maximumAttempts: 5,
  backoffCoefficient: 2,
  maximumInterval: '300s',
}

OptionalsecuredWorker

securedWorker?: boolean

When true, worker stream operations use SECURITY DEFINER stored procedures instead of raw SQL. Enabled automatically when the worker connects with scoped workerCredentials.

Optionalsqs

sqs?: {
    deadLetterQueue?: string;
    dlqArn?: string;
    messageRetentionPeriod?: number;
    visibilityTimeout?: number;
    waitTimeSeconds?: number;
}

Optionaltimeout

timeout?: number

Settings

Member Visibility

On This Page

Properties