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

    Type Alias ConsumerConfig

    ConsumerConfig: ConsumerUpdateConfig & {
        ack_policy: AckPolicy;
        deliver_group?: string;
        deliver_policy: DeliverPolicy;
        durable_name?: string;
        flow_control?: boolean;
        idle_heartbeat?: Nanos;
        name?: string;
        opt_start_seq?: number;
        opt_start_time?: string;
        pause_until?: string;
        rate_limit_bps?: number;
        replay_policy: ReplayPolicy;
    }

    Type declaration

    • ack_policy: AckPolicy

      The type of acknowledgment required by the Consumer

    • Optionaldeliver_group?: string

      Allows push consumers to form a queue group

    • deliver_policy: DeliverPolicy

      Where to start consuming messages on the stream

    • Optionaldurable_name?: string

      A unique name for a durable consumer. Set name for ephemeral consumers

    • Optionalflow_control?: boolean

      For push consumers this will regularly send an empty mess with Status header 100 and a reply subject, consumers must reply to these messages to control the rate of message delivery.

    • Optionalidle_heartbeat?: Nanos

      If the Consumer is idle for more than this many nanoseconds an empty message with Status header 100 will be sent indicating the consumer is still alive

    • Optionalname?: string

      The consumer name

    • Optionalopt_start_seq?: number

      The sequence from which to start delivery messages. Requires DeliverPolicy#StartSequence

    • Optionalopt_start_time?: string

      The date time from which to start delivering messages Requires DeliverPolicy#StartTime

    • Optionalpause_until?: string

      Creates a consumer that is initially paused, but will resume at the specified Date and time. Specified as an ISO date time string (Date#toISOString()).

    • Optionalrate_limit_bps?: number

      The rate at which messages will be delivered to clients, expressed in bytes per second

    • replay_policy: ReplayPolicy

      How messages are played back to the Consumer

    Settings

    Member Visibility