@nats-io/jetstream
    Preparing search index...

    Type Alias ScheduleOptions

    type ScheduleOptions = {
        rollup?: "sub";
        source?: string;
        specification: string | Date | ScheduleSpec;
        target: string;
        timezone?: string;
        ttl?: string;
    }
    Index

    Properties

    rollup? source? specification target timezone? ttl?

    Properties

    rollup?: "sub"

    Per-subject rollup behavior on the target stream. Only "sub" is defined. Requires server v2.14.0+.

    source?: string

    Instructs the schedule to read the last message on the given subject and publish. If the subject is empty, nothing is published. Wildcards are NOT supported.

    specification: string | Date | ScheduleSpec

    The schedule specification.

    Accepts:

    • ScheduleSpec - typed builder (preferred).
    • Date - convenience for single-shot @at <iso>.
    • string - raw header value (e.g. "@every 1s", "0 0 5 * * *", "@at 2026-01-01T00:00:00Z").

    Server support per format:

    • @at - v2.12.0+
    • @every, cron, predefined, timezone - v2.14.0+
    target: string

    The subject the message will be delivered to

    timezone?: string

    IANA timezone name (e.g. "America/Denver"). Applies to cron and predefined schedules only. Requires server v2.14.0+.

    ttl?: string

    Sets a message TTL if the stream supports per-message TTL.

    Settings

    Member Visibility

    On This Page

    Properties