KafkaConsumerOptions

Defined in: packages/pubsub/src/kafka/types.ts:24

Kafka consumer client options, with groupId supplied from subscribe options when present.

Extends

Omit<KafkaJS.ConsumerConstructorConfig, "kafkaJS">

Properties

allow.auto.create.topics?

optional allow.auto.create.topics?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:378

Allow automatic topic creation on the broker when subscribing to or assigning non-existent topics. The broker must also be configured with auto.create.topics.enable=true for this configuration to take effect. Note: the default value (true) for the producer is different from the default value (false) for the consumer. Further, the consumer default value is different from the Java consumer (true), and this property is not supported by the Java producer. Requires broker version >= 0.11.0.0, for older broker versions only the broker configuration applies.

Default

false

Inherited from

Omit.allow.auto.create.topics

api.version.fallback.ms?

optional api.version.fallback.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:364

DEPRECATED Post-deprecation actions: remove this configuration property, brokers < 0.10.0 won’t be supported anymore in librdkafka 3.x. Dictates how long the broker.version.fallback fallback is used in the case the ApiVersionRequest fails. NOTE: The ApiVersionRequest is only issued when a new connection to the broker is made (such as after an upgrade).

Default

Inherited from

Omit.api.version.fallback.ms

api.version.request?

optional api.version.request?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:350

DEPRECATED Post-deprecation actions: remove this configuration property, brokers < 0.10.0 won’t be supported anymore in librdkafka 3.x. Request broker’s supported API versions to adjust functionality to available protocol features. If set to false, or the ApiVersionRequest fails, the fallback version broker.version.fallback will be used. NOTE: Depends on broker version >=0.10.0. If the request is not supported by (an older) broker the broker.version.fallback fallback is used.

Default

true

Inherited from

Omit.api.version.request

api.version.request.timeout.ms?

optional api.version.request.timeout.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:357

Timeout for broker API version requests.

Default

Inherited from

Omit.api.version.request.timeout.ms

auto.commit.enable?

optional auto.commit.enable?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1205

DEPRECATED [LEGACY PROPERTY: This property is used by the simple legacy consumer only. When using the high-level KafkaConsumer, the global enable.auto.commit property must be used instead]. If true, periodically commit offset of the last message handed to the application. This committed offset will be used when the process restarts to pick up where it left off. If false, the application will have to call rd_kafka_offset_store() to store an offset (optional). Offsets will be written to broker or local file according to offset.store.method.

Default

true

Inherited from

Omit.auto.commit.enable

auto.commit.interval.ms?

optional auto.commit.interval.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:987

The frequency in milliseconds that the consumer offsets are committed (written) to offset storage. (0 = disable). This setting is used by the high-level consumer.

Default

Inherited from

Omit.auto.commit.interval.ms

auto.offset.reset?

optional auto.offset.reset?: "error" | "smallest" | "earliest" | "beginning" | "largest" | "latest" | "end"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1226

Action to take when there is no initial offset in offset store or the desired offset is out of range: ‘smallest’,‘earliest’ - automatically reset the offset to the smallest offset, ‘largest’,‘latest’ - automatically reset the offset to the largest offset, ‘error’ - trigger an error (ERR__AUTO_OFFSET_RESET) which is retrieved by consuming messages and checking ‘message->err’.

Default

largest

Inherited from

Omit.auto.offset.reset

background_event_cb?

optional background_event_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:301

Background queue event callback (set with rd_kafka_conf_set_background_event_cb())

Inherited from

Omit.background_event_cb

bootstrap.servers?

optional bootstrap.servers?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:28

Alias for metadata.broker.list: Initial list of brokers as a CSV list of broker host or host:port. The application may also use rd_kafka_brokers_add() to add brokers during runtime.

Inherited from

Omit.bootstrap.servers

broker.address.family?

optional broker.address.family?: "any" | "v4" | "v6"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:192

Allowed broker IP address families: any, v4, v6

Default

any

Inherited from

Omit.broker.address.family

broker.address.ttl?

optional broker.address.ttl?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:185

How long to cache the broker address resolving results (milliseconds).

Default

Inherited from

Omit.broker.address.ttl

broker.version.fallback?

optional broker.version.fallback?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:371

DEPRECATED Post-deprecation actions: remove this configuration property, brokers < 0.10.0 won’t be supported anymore in librdkafka 3.x. Older broker versions (before 0.10.0) provide no way for a client to query for supported protocol features (ApiVersionRequest, see api.version.request) making it impossible for the client to know what features it may use. As a workaround a user may set this property to the expected broker version and the client will automatically adjust its feature set accordingly if the ApiVersionRequest fails (or is disabled). The fallback broker version will be used for api.version.fallback.ms. Valid values are: 0.9.0, 0.8.2, 0.8.1, 0.8.0. Any other value >= 0.10, such as 0.10.2.1, enables ApiVersionRequests.

Default

0.10.0

Inherited from

Omit.broker.version.fallback

builtin.features?

optional builtin.features?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:11

Indicates the builtin features for this build of librdkafka. An application can either query this value or attempt to set it with its list of required features to check for library support.

Default

gzip, snappy, ssl, sasl, regex, lz4, sasl_gssapi, sasl_plain, sasl_scram, plugins, zstd, sasl_oauthbearer, http, oidc

Inherited from

Omit.builtin.features

check.crcs?

optional check.crcs?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1100

Verify CRC32 of consumed messages, ensuring no on-the-wire or on-disk corruption to the messages occurred. This check comes at slightly increased CPU usage.

Default

false

Inherited from

Omit.check.crcs

client.dns.lookup?

optional client.dns.lookup?: "use_all_dns_ips" | "resolve_canonical_bootstrap_servers_only"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:764

Controls how the client uses DNS lookups. By default, when the lookup returns multiple IP addresses for a hostname, they will all be attempted for connection before the connection is considered failed. This applies to both bootstrap and advertised servers. If the value is set to resolve_canonical_bootstrap_servers_only, each entry will be resolved and expanded into a list of canonical names. WARNING: resolve_canonical_bootstrap_servers_only must only be used with GSSAPI (Kerberos) as sasl.mechanism, as it’s the only purpose of this configuration value. NOTE: Default here is different from the Java client’s default behavior, which connects only to the first IP address returned for a hostname.

Default

use_all_dns_ips

Inherited from

Omit.client.dns.lookup

client.id?

optional client.id?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:18

Client identifier.

Default

rdkafka

Inherited from

Omit.client.id

client.rack?

optional client.rack?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:743

A rack identifier for this client. This can be any string value which indicates where this client is physically located. It corresponds with the broker config broker.rack.

Inherited from

Omit.client.rack

closesocket_cb?

optional closesocket_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:316

Socket close callback

Inherited from

Omit.closesocket_cb

connect_cb?

optional connect_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:311

Socket connect callback

Inherited from

Omit.connect_cb

connections.max.idle.ms?

optional connections.max.idle.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:206

Close broker connections after the specified time of inactivity. Disable with 0. If this property is left at its default value some heuristics are performed to determine a suitable default value, this is currently limited to identifying brokers on Azure (see librdkafka issue #3109 for more info). Actual value can be lower, up to 2s lower, only if connections.max.idle.ms >= 4s, as jitter is added to avoid disconnecting all brokers at the same time.

Default

Inherited from

Omit.connections.max.idle.ms

consume_cb?

optional consume_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1076

Message consume callback (set with rd_kafka_conf_set_consume_cb())

Inherited from

Omit.consume_cb

consume.callback.max.messages?

optional consume.callback.max.messages?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1254

Maximum number of messages to dispatch in one rd_kafka_consume_callback*() call (0 = unlimited)

Default

Inherited from

Omit.consume.callback.max.messages

coordinator.query.interval.ms?

optional coordinator.query.interval.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:966

How often to query for the current client group coordinator. If the currently assigned coordinator is down the configured query interval will be divided by ten to more quickly recover in case of coordinator reassignment.

Default

Inherited from

Omit.coordinator.query.interval.ms

debug?

optional debug?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:129

A comma-separated list of debug contexts to enable. Detailed Producer debugging: broker,topic,msg. Consumer: consumer,cgrp,topic,fetch

Inherited from

Omit.debug

default_topic_conf?

optional default_topic_conf?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:336

Default topic configuration for automatically subscribed topics

Inherited from

Omit.default_topic_conf

enable.auto.commit?

optional enable.auto.commit?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:980

Automatically and periodically commit offsets in the background. Note: setting this to false does not prevent the consumer from fetching previously committed start offsets. To circumvent this behaviour set specific start offsets per partition in the call to assign().

Default

true

Inherited from

Omit.enable.auto.commit

enable.auto.offset.store?

optional enable.auto.offset.store?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:994

Automatically store offset of last message provided to application. The offset store is an in-memory store of the next offset to (auto-)commit for each partition.

Default

true

Inherited from

Omit.enable.auto.offset.store

enable.metrics.push?

optional enable.metrics.push?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:771

Whether to enable pushing of client metrics to the cluster, if the cluster has a client metrics subscription which matches this client

Default

true

Inherited from

Omit.enable.metrics.push

enable.partition.eof?

optional enable.partition.eof?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1093

Emit RD_KAFKA_RESP_ERR__PARTITION_EOF event whenever the consumer reaches the end of a partition.

Default

false

Inherited from

Omit.enable.partition.eof

enable.random.seed?

optional enable.random.seed?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:289

If enabled librdkafka will initialize the PRNG with srand(current_time.milliseconds) on the first invocation of rd_kafka_new() (required only if rand_r() is not available on your platform). If disabled the application must call srand() prior to calling rd_kafka_new().

Default

true

Inherited from

Omit.enable.random.seed

enable.sasl.oauthbearer.unsecure.jwt?

optional enable.sasl.oauthbearer.unsecure.jwt?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:592

Enable the builtin unsecure JWT OAUTHBEARER token handler if no oauthbearer_refresh_cb has been set. This builtin handler should only be used for development or testing, and not in production.

Default

false

Inherited from

Omit.enable.sasl.oauthbearer.unsecure.jwt

enable.ssl.certificate.verification?

optional enable.ssl.certificate.verification?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:511

Enable OpenSSL’s builtin broker (server) certificate verification. This verification can be extended by the application by implementing a certificate_verify_cb.

Default

true

Inherited from

Omit.enable.ssl.certificate.verification

enabled_events?

optional enabled_events?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:241

See rd_kafka_conf_set_events()

Default

Inherited from

Omit.enabled_events

error_cb?

optional error_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:246

Error callback (set with rd_kafka_conf_set_error_cb())

Inherited from

Omit.error_cb

event_cb?

optional event_cb?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:778

Enables or disables event.* emitting.

Default

true

Inherited from

Omit.event_cb

fetch.error.backoff.ms?

optional fetch.error.backoff.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1057

How long to postpone the next fetch request for a topic+partition in case of a fetch error.

Default

Inherited from

Omit.fetch.error.backoff.ms

fetch.max.bytes?

optional fetch.max.bytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1043

Maximum amount of data the broker shall return for a Fetch request. Messages are fetched in batches by the consumer and if the first message batch in the first non-empty partition of the Fetch request is larger than this value, then the message batch will still be returned to ensure the consumer can make progress. The maximum message batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (broker topic config). fetch.max.bytes is automatically adjusted upwards to be at least message.max.bytes (consumer config).

Default

52428800

Inherited from

Omit.fetch.max.bytes

fetch.message.max.bytes?

optional fetch.message.max.bytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1029

Initial maximum number of bytes per topic+partition to request when fetching messages from the broker. If the client encounters a message larger than this value it will gradually try to increase it until the entire message can be fetched.

Default

Inherited from

Omit.fetch.message.max.bytes

fetch.min.bytes?

optional fetch.min.bytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1050

Minimum number of bytes the broker responds with. If fetch.wait.max.ms expires the accumulated data will be sent to the client regardless of this setting.

Default

Inherited from

Omit.fetch.min.bytes

fetch.queue.backoff.ms?

optional fetch.queue.backoff.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1022

How long to postpone the next fetch request for a topic+partition in case the current fetch queue thresholds (queued.min.messages or queued.max.messages.kbytes) have been exceded. This property may need to be decreased if the queue thresholds are set low and the application is experiencing long (~1s) delays between messages. Low values may increase CPU utilization.

Default

Inherited from

Omit.fetch.queue.backoff.ms

fetch.wait.max.ms?

optional fetch.wait.max.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1015

Maximum time the broker may wait to fill the Fetch response with fetch.min.bytes of messages.

Default

Inherited from

Omit.fetch.wait.max.ms

group.id?

optional group.id?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:914

Client group id string. All clients sharing the same group.id belong to the same group.

Inherited from

Omit.group.id

group.instance.id?

optional group.instance.id?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:919

Enable static group membership. Static group members are able to leave and rejoin a group within the configured session.timeout.ms without prompting a group rebalance. This should be used in combination with a larger session.timeout.ms to avoid group rebalances caused by transient unavailability (e.g. process restarts). Requires broker version >= 2.3.0.

Inherited from

Omit.group.instance.id

group.protocol?

optional group.protocol?: "classic" | "consumer"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:954

Group protocol to use. Use classic for the original protocol and consumer for the new protocol introduced in KIP-848. Available protocols: classic or consumer. Default is classic, but will change to consumer in next releases.

Default

classic

Inherited from

Omit.group.protocol

group.protocol.type?

optional group.protocol.type?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:947

Group protocol type for the classic group protocol. NOTE: Currently, the only supported group protocol type is consumer. group.protocol.type is not supported for group.protocol=consumer

Default

consumer

Inherited from

Omit.group.protocol.type

group.remote.assignor?

optional group.remote.assignor?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:959

Server side assignor to use. Keep it null to make server select a suitable assignor for the group. Available assignors: uniform or range. Default is null

Inherited from

Omit.group.remote.assignor

heartbeat.interval.ms?

optional heartbeat.interval.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:940

Group session keepalive heartbeat interval. heartbeat.interval.ms is not supported for group.protocol=consumer. It is set with the broker configuration property group.consumer.heartbeat.interval.ms by default or can be configured through the AdminClient IncrementalAlterConfigs API. The allowed range is configured with the broker configuration properties group.consumer.min.heartbeat.interval.ms and group.consumer.max.heartbeat.interval.ms.

Default

Inherited from

Omit.heartbeat.interval.ms

https.ca.location?

optional https.ca.location?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:445

File or directory path to CA certificate(s) for verifying HTTPS endpoints, like sasl.oauthbearer.token.endpoint.url used for OAUTHBEARER/OIDC authentication. Mutually exclusive with https.ca.pem. Defaults: On Windows the system’s CA certificates are automatically looked up in the Windows Root certificate store. On Mac OSX this configuration defaults to probe. It is recommended to install openssl using Homebrew, to provide CA certificates. On Linux install the distribution’s ca-certificates package. If OpenSSL is statically linked or https.ca.location is set to probe a list of standard paths will be probed and the first one found will be used as the default CA certificate location path. If OpenSSL is dynamically linked the OpenSSL library’s default path will be used (see OPENSSLDIR in openssl version -a).

Inherited from

Omit.https.ca.location

https.ca.pem?

optional https.ca.pem?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:450

CA certificate string (PEM format) for verifying HTTPS endpoints. Mutually exclusive with https.ca.location. Optional: see https.ca.location.

Inherited from

Omit.https.ca.pem

interceptors?

optional interceptors?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:738

Interceptors added through rd_kafka_conf_interceptor_add_..() and any configuration handled by interceptors.

Inherited from

Omit.interceptors

internal.termination.signal?

optional internal.termination.signal?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:343

Signal that librdkafka will use to quickly terminate on rd_kafka_destroy(). If this signal is not set then there will be a delay before rd_kafka_wait_destroyed() returns true as internal threads are timing out their system calls. If this signal is set however the delay will be minimal. The application should mask this signal as an internal signal handler is installed.

Default

Inherited from

Omit.internal.termination.signal

isolation.level?

optional isolation.level?: "read_uncommitted" | "read_committed"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1071

Controls how to read messages written transactionally: read_committed - only return transactional messages which have been committed. read_uncommitted - return all messages, even transactional messages which have been aborted.

Default

read_committed

Inherited from

Omit.isolation.level

js.consumer.max.batch.size?

optional js.consumer.max.batch.size?: string | number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/kafkajs.d.ts:254

Maximum batch size passed in eachBatch calls. A value of -1 means no limit.

Default

Inherited from

Omit.js.consumer.max.batch.size

js.consumer.max.cache.size.per.worker.ms?

optional js.consumer.max.cache.size.per.worker.ms?: string | number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/kafkajs.d.ts:261

Maximum cache size per worker in milliseconds based on the consume rate estimated through the eachMessage/eachBatch calls.

Default

Inherited from

Omit.js.consumer.max.cache.size.per.worker.ms

kafkaJS?

optional kafkaJS?: Omit<ConsumerConfig, "groupId"> & object

Defined in: packages/pubsub/src/kafka/types.ts:26

KafkaJS-compatible consumer options.

Type Declaration

groupId?

optional groupId?: string

Default consumer group used when subscribe options do not provide one.

log_cb?

optional log_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:261

Log callback (set with rd_kafka_conf_set_log_cb())

Inherited from

Omit.log_cb

log_level?

optional log_level?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:268

Logging level (syslog(3) levels)

Default

Inherited from

Omit.log_level

log.connection.close?

optional log.connection.close?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:296

Log broker disconnects. It might be useful to turn this off when interacting with 0.9 brokers with an aggressive connections.max.idle.ms value.

Default

true

Inherited from

Omit.log.connection.close

log.queue?

optional log.queue?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:275

Disable spontaneous log_cb from internal librdkafka threads, instead enqueue log messages on queue set with rd_kafka_set_log_queue() and serve log callbacks or events through the standard poll APIs. NOTE: Log messages will linger in a temporary queue until the log queue has been set.

Default

false

Inherited from

Omit.log.queue

log.thread.name?

optional log.thread.name?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:282

Print internal thread name in log messages (useful for debugging librdkafka internals)

Default

true

Inherited from

Omit.log.thread.name

max.in.flight?

optional max.in.flight?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:63

Alias for max.in.flight.requests.per.connection: Maximum number of in-flight requests per broker connection. This is a generic property applied to all broker communication, however it is primarily relevant to produce requests. In particular, note that other mechanisms limit the number of outstanding consumer fetch request per broker to one.

Default

Inherited from

Omit.max.in.flight

max.in.flight.requests.per.connection?

optional max.in.flight.requests.per.connection?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:56

Maximum number of in-flight requests per broker connection. This is a generic property applied to all broker communication, however it is primarily relevant to produce requests. In particular, note that other mechanisms limit the number of outstanding consumer fetch request per broker to one.

Default

Inherited from

Omit.max.in.flight.requests.per.connection

max.partition.fetch.bytes?

optional max.partition.fetch.bytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1036

Alias for fetch.message.max.bytes: Initial maximum number of bytes per topic+partition to request when fetching messages from the broker. If the client encounters a message larger than this value it will gradually try to increase it until the entire message can be fetched.

Default

Inherited from

Omit.max.partition.fetch.bytes

max.poll.interval.ms?

optional max.poll.interval.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:973

Maximum allowed time between calls to consume messages (e.g., rd_kafka_consumer_poll()) for high-level consumers. If this interval is exceeded the consumer is considered failed and the group will rebalance in order to reassign the partitions to another consumer group member. Warning: Offset commits may be not possible at this point. Note: It is recommended to set enable.auto.offset.store=false for long-time processing applications and then explicitly store offsets (using offsets_store()) after message processing, to make sure offsets are not auto-committed prior to processing has finished. The interval is checked two times per second. See KIP-62 for more information.

Default

Inherited from

Omit.max.poll.interval.ms

message.copy.max.bytes?

optional message.copy.max.bytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:42

Maximum size for message to be copied to buffer. Messages larger than this will be passed by reference (zero-copy) at the expense of larger iovecs.

Default

Inherited from

Omit.message.copy.max.bytes

message.max.bytes?

optional message.max.bytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:35

Maximum Kafka protocol request message size. Due to differing framing overhead between protocol versions the producer is unable to reliably enforce a strict max message limit at produce time and may exceed the maximum size by one message in protocol ProduceRequests, the broker will enforce the the topic’s max.message.bytes limit (see Apache Kafka documentation).

Default

Inherited from

Omit.message.max.bytes

metadata.broker.list?

optional metadata.broker.list?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:23

Initial list of brokers as a CSV list of broker host or host:port. The application may also use rd_kafka_brokers_add() to add brokers during runtime.

Inherited from

Omit.metadata.broker.list

metadata.max.age.ms?

optional metadata.max.age.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:91

Metadata cache max age. Defaults to topic.metadata.refresh.interval.ms * 3

Default

Inherited from

Omit.metadata.max.age.ms

metadata.recovery.rebootstrap.trigger.ms?

optional metadata.recovery.rebootstrap.trigger.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:77

If a client configured to rebootstrap using metadata.recovery.strategy=rebootstrap is unable to obtain metadata from any of the brokers for this interval, client repeats the bootstrap process using bootstrap.servers configuration and brokers added through rd_kafka_brokers_add().

Default

Inherited from

Omit.metadata.recovery.rebootstrap.trigger.ms

metadata.recovery.strategy?

optional metadata.recovery.strategy?: "none" | "rebootstrap"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:70

Controls how the client recovers when none of the brokers known to it is available. If set to none, the client doesn’t re-bootstrap. If set to rebootstrap, the client repeats the bootstrap process using bootstrap.servers and brokers added through rd_kafka_brokers_add(). Rebootstrapping is useful when a client communicates with brokers so infrequently that the set of brokers may change entirely before the client refreshes metadata. Metadata recovery is triggered when all last-known brokers appear unavailable simultaneously or the client cannot refresh metadata within metadata.recovery.rebootstrap.trigger.ms or it’s requested in a metadata response.

Default

rebootstrap

Inherited from

Omit.metadata.recovery.strategy

oauthbearer_token_refresh_cb?

optional oauthbearer_token_refresh_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:597

SASL/OAUTHBEARER token refresh callback (set with rd_kafka_conf_set_oauthbearer_token_refresh_cb(), triggered by rd_kafka_poll(), et.al. This callback will be triggered when it is time to refresh the client’s OAUTHBEARER token. Also see rd_kafka_conf_enable_sasl_queue().

Inherited from

Omit.oauthbearer_token_refresh_cb

offset_commit_cb?

optional offset_commit_cb?: boolean | Function

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1086

Offset commit result propagation callback. (set with rd_kafka_conf_set_offset_commit_cb())

Inherited from

Omit.offset_commit_cb

offset.store.method?

optional offset.store.method?: "file" | "broker"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1064

DEPRECATED Offset commit store method: ‘file’ - DEPRECATED: local file store (offset.store.path, et.al), ‘broker’ - broker commit store (requires Apache Kafka 0.8.2 or later on the broker).

Default

broker

Inherited from

Omit.offset.store.method

offset.store.path?

optional offset.store.path?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1233

DEPRECATED Path to local file for storing offsets. If the path is a directory a filename will be automatically generated in that directory based on the topic and partition. File-based offset storage will be removed in a future version.

Default

Inherited from

Omit.offset.store.path

offset.store.sync.interval.ms?

optional offset.store.sync.interval.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1240

DEPRECATED fsync() interval for the offset file, in milliseconds. Use -1 to disable syncing, and 0 for immediate sync after each write. File-based offset storage will be removed in a future version.

Default

-1

Inherited from

Omit.offset.store.sync.interval.ms

opaque?

optional opaque?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:331

Application opaque (set with rd_kafka_conf_set_opaque())

Inherited from

Omit.opaque

open_cb?

optional open_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:321

File open callback to provide race-free CLOEXEC

Inherited from

Omit.open_cb

partition.assignment.strategy?

optional partition.assignment.strategy?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:926

The name of one or more partition assignment strategies. The elected group leader will use a strategy supported by all members of the group to assign partitions to group members. If there is more than one eligible strategy, preference is determined by the order of this list (strategies earlier in the list have higher priority). Cooperative and non-cooperative (eager)strategies must not be mixed. partition.assignment.strategy is not supported for group.protocol=consumer. Use group.remote.assignor instead. Available strategies: range, roundrobin, cooperative-sticky.

Default

range,roundrobin

Inherited from

Omit.partition.assignment.strategy

plugin.library.paths?

optional plugin.library.paths?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:733

List of plugin libraries to load (; separated). The library search path is platform dependent (see dlopen(3) for Unix and LoadLibrary() for Windows). If no filename extension is specified the platform-specific extension (such as .dll or .so) will be appended automatically.

Inherited from

Omit.plugin.library.paths

queued.max.messages.kbytes?

optional queued.max.messages.kbytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1008

Maximum number of kilobytes of queued pre-fetched messages in the local consumer queue. If using the high-level consumer this setting applies to the single consumer queue, regardless of the number of partitions. When using the legacy simple consumer or when separate partition queues are used this setting applies per partition. This value may be overshot by fetch.message.max.bytes. This property has higher priority than queued.min.messages.

Default

Inherited from

Omit.queued.max.messages.kbytes

queued.min.messages?

optional queued.min.messages?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1001

Minimum number of messages per topic+partition librdkafka tries to maintain in the local consumer queue.

Default

Inherited from

Omit.queued.min.messages

rebalance_cb?

optional rebalance_cb?: boolean | Function

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:1081

Called after consumer group has been rebalanced (set with rd_kafka_conf_set_rebalance_cb())

Inherited from

Omit.rebalance_cb

receive.message.max.bytes?

optional receive.message.max.bytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:49

Maximum Kafka protocol response message size. This serves as a safety precaution to avoid memory exhaustion in case of protocol hickups. This value must be at least fetch.max.bytes + 512 to allow for protocol overhead; the value is adjusted automatically unless the configuration property is explicitly set.

Default

100000000

Inherited from

Omit.receive.message.max.bytes

reconnect.backoff.jitter.ms?

optional reconnect.backoff.jitter.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:213

DEPRECATED No longer used. See reconnect.backoff.ms and reconnect.backoff.max.ms.

Default

Inherited from

Omit.reconnect.backoff.jitter.ms

reconnect.backoff.max.ms?

optional reconnect.backoff.max.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:227

The maximum time to wait before reconnecting to a broker after the connection has been closed.

Default

Inherited from

Omit.reconnect.backoff.max.ms

reconnect.backoff.ms?

optional reconnect.backoff.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:220

The initial time to wait before reconnecting to a broker after the connection has been closed. The time is increased exponentially until reconnect.backoff.max.ms is reached. -25% to +50% jitter is applied to each reconnect backoff. A value of 0 disables the backoff and reconnects immediately.

Default

Inherited from

Omit.reconnect.backoff.ms

resolve_cb?

optional resolve_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:326

Address resolution callback (set with rd_kafka_conf_set_resolve_cb()).

Inherited from

Omit.resolve_cb

retry.backoff.max.ms?

optional retry.backoff.max.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:757

The max backoff time in milliseconds before retrying a protocol request, this is the atmost backoff allowed for exponentially backed off requests.

Default

Inherited from

Omit.retry.backoff.max.ms

retry.backoff.ms?

optional retry.backoff.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:750

The backoff time in milliseconds before retrying a protocol request, this is the first backoff time, and will be backed off exponentially until number of retries is exhausted, and it’s capped by retry.backoff.max.ms.

Default

Inherited from

Omit.retry.backoff.ms

sasl.kerberos.keytab?

optional sasl.kerberos.keytab?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:563

Path to Kerberos keytab file. This configuration property is only used as a variable in sasl.kerberos.kinit.cmd as ... -t "%{sasl.kerberos.keytab}".

Inherited from

Omit.sasl.kerberos.keytab

sasl.kerberos.kinit.cmd?

optional sasl.kerberos.kinit.cmd?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:558

kinit -t ”%{sasl.kerberos.keytab}” -k %{sasl.kerberos.principal} | low | Shell command to refresh or acquire the client’s Kerberos ticket. This command is executed on client creation and every sasl.kerberos.min.time.before.relogin (0=disable). %{config.prop.name} is replaced by corresponding config object value.

Default

kinit -R -t "%{sasl.kerberos.keytab}" -k %{sasl.kerberos.principal} \

Inherited from

Omit.sasl.kerberos.kinit.cmd

sasl.kerberos.min.time.before.relogin?

optional sasl.kerberos.min.time.before.relogin?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:570

Minimum time in milliseconds between key refresh attempts. Disable automatic key refresh by setting this property to 0.

Default

Inherited from

Omit.sasl.kerberos.min.time.before.relogin

sasl.kerberos.principal?

optional sasl.kerberos.principal?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:551

This client’s Kerberos principal name. (Not supported on Windows, will use the logon user’s principal).

Default

kafkaclient

Inherited from

Omit.sasl.kerberos.principal

sasl.kerberos.service.name?

optional sasl.kerberos.service.name?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:544

Kerberos principal name that Kafka runs as, not including /hostname@REALM

Default

kafka

Inherited from

Omit.sasl.kerberos.service.name

sasl.mechanism?

optional sasl.mechanism?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:537

Alias for sasl.mechanisms: SASL mechanism to use for authentication. Supported: GSSAPI, PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, OAUTHBEARER. NOTE: Despite the name only one mechanism must be configured.

Default

GSSAPI

Inherited from

Omit.sasl.mechanism

sasl.mechanisms?

optional sasl.mechanisms?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:530

SASL mechanism to use for authentication. Supported: GSSAPI, PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, OAUTHBEARER. NOTE: Despite the name only one mechanism must be configured.

Default

GSSAPI

Inherited from

Omit.sasl.mechanisms

sasl.oauthbearer.assertion.algorithm?

optional sasl.oauthbearer.assertion.algorithm?: "RS256" | "ES256"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:660

Algorithm the client should use to sign the assertion sent to the identity provider and in the OAuth alg header in the JWT assertion.

Default

RS256

Inherited from

Omit.sasl.oauthbearer.assertion.algorithm

sasl.oauthbearer.assertion.claim.aud?

optional sasl.oauthbearer.assertion.claim.aud?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:685

JWT audience claim. Only used when sasl.oauthbearer.method is set to “oidc” and JWT assertion is needed.

Inherited from

Omit.sasl.oauthbearer.assertion.claim.aud

sasl.oauthbearer.assertion.claim.exp.seconds?

optional sasl.oauthbearer.assertion.claim.exp.seconds?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:692

Assertion expiration time in seconds. Only used when sasl.oauthbearer.method is set to “oidc” and JWT assertion is needed.

Default

Inherited from

Omit.sasl.oauthbearer.assertion.claim.exp.seconds

sasl.oauthbearer.assertion.claim.iss?

optional sasl.oauthbearer.assertion.claim.iss?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:697

JWT issuer claim. Only used when sasl.oauthbearer.method is set to “oidc” and JWT assertion is needed.

Inherited from

Omit.sasl.oauthbearer.assertion.claim.iss

sasl.oauthbearer.assertion.claim.jti.include?

optional sasl.oauthbearer.assertion.claim.jti.include?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:704

JWT ID claim. When set to true, a random UUID is generated. Only used when sasl.oauthbearer.method is set to “oidc” and JWT assertion is needed.

Default

false

Inherited from

Omit.sasl.oauthbearer.assertion.claim.jti.include

sasl.oauthbearer.assertion.claim.nbf.seconds?

optional sasl.oauthbearer.assertion.claim.nbf.seconds?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:711

Assertion not before time in seconds. Only used when sasl.oauthbearer.method is set to “oidc” and JWT assertion is needed.

Default

Inherited from

Omit.sasl.oauthbearer.assertion.claim.nbf.seconds

sasl.oauthbearer.assertion.claim.sub?

optional sasl.oauthbearer.assertion.claim.sub?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:716

JWT subject claim. Only used when sasl.oauthbearer.method is set to “oidc” and JWT assertion is needed.

Inherited from

Omit.sasl.oauthbearer.assertion.claim.sub

sasl.oauthbearer.assertion.file?

optional sasl.oauthbearer.assertion.file?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:680

Path to the assertion file. Only used when sasl.oauthbearer.method is set to “oidc” and JWT assertion is needed.

Inherited from

Omit.sasl.oauthbearer.assertion.file

sasl.oauthbearer.assertion.jwt.template.file?

optional sasl.oauthbearer.assertion.jwt.template.file?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:721

Path to the JWT template file. Only used when sasl.oauthbearer.method is set to “oidc” and JWT assertion is needed.

Inherited from

Omit.sasl.oauthbearer.assertion.jwt.template.file

sasl.oauthbearer.assertion.private.key.file?

optional sasl.oauthbearer.assertion.private.key.file?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:665

Path to client’s private key (PEM) used for authentication when using the JWT assertion.

Inherited from

Omit.sasl.oauthbearer.assertion.private.key.file

sasl.oauthbearer.assertion.private.key.passphrase?

optional sasl.oauthbearer.assertion.private.key.passphrase?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:670

Private key passphrase for sasl.oauthbearer.assertion.private.key.file or sasl.oauthbearer.assertion.private.key.pem.

Inherited from

Omit.sasl.oauthbearer.assertion.private.key.passphrase

sasl.oauthbearer.assertion.private.key.pem?

optional sasl.oauthbearer.assertion.private.key.pem?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:675

Client’s private key (PEM) used for authentication when using the JWT assertion.

Inherited from

Omit.sasl.oauthbearer.assertion.private.key.pem

sasl.oauthbearer.client.credentials.client.id?

optional sasl.oauthbearer.client.credentials.client.id?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:614

Alias for sasl.oauthbearer.client.id: Public identifier for the application. Must be unique across all clients that the authorization server handles. Only used when sasl.oauthbearer.method is set to “oidc”.

Inherited from

Omit.sasl.oauthbearer.client.credentials.client.id

sasl.oauthbearer.client.credentials.client.secret?

optional sasl.oauthbearer.client.credentials.client.secret?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:619

Alias for sasl.oauthbearer.client.secret: Client secret only known to the application and the authorization server. This should be a sufficiently random string that is not guessable. Only used when sasl.oauthbearer.method is set to “oidc”.

Inherited from

Omit.sasl.oauthbearer.client.credentials.client.secret

sasl.oauthbearer.client.id?

optional sasl.oauthbearer.client.id?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:609

Public identifier for the application. Must be unique across all clients that the authorization server handles. Only used when sasl.oauthbearer.method is set to “oidc”.

Inherited from

Omit.sasl.oauthbearer.client.id

sasl.oauthbearer.client.secret?

optional sasl.oauthbearer.client.secret?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:624

Client secret only known to the application and the authorization server. This should be a sufficiently random string that is not guessable. Only used when sasl.oauthbearer.method is set to “oidc”.

Inherited from

Omit.sasl.oauthbearer.client.secret

sasl.oauthbearer.config?

optional sasl.oauthbearer.config?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:585

SASL/OAUTHBEARER configuration. The format is implementation-dependent and must be parsed accordingly. The default unsecured token implementation (see https://tools.ietf.org/html/rfc7515#appendix-A.5) recognizes space-separated name=value pairs with valid names including principalClaimName, principal, scopeClaimName, scope, and lifeSeconds. The default value for principalClaimName is “sub”, the default value for scopeClaimName is “scope”, and the default value for lifeSeconds is 3600. The scope value is CSV format with the default value being no/empty scope. For example: principalClaimName=azp principal=admin scopeClaimName=roles scope=role1,role2 lifeSeconds=600. In addition, SASL extensions can be communicated to the broker via extension_NAME=value. For example: principal=admin extension_traceId=123

Inherited from

Omit.sasl.oauthbearer.config

sasl.oauthbearer.extensions?

optional sasl.oauthbearer.extensions?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:634

Allow additional information to be provided to the broker. Comma-separated list of key=value pairs. E.g., “supportFeatureX=true,organizationId=sales-emea”.Only used when sasl.oauthbearer.method is set to “oidc”.

Inherited from

Omit.sasl.oauthbearer.extensions

sasl.oauthbearer.grant.type?

optional sasl.oauthbearer.grant.type?: "client_credentials" | "urn:ietf:params:oauth:grant-type:jwt-bearer"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:653

OAuth grant type to use when communicating with the identity provider.

Default

client_credentials

Inherited from

Omit.sasl.oauthbearer.grant.type

sasl.oauthbearer.metadata.authentication.type?

optional sasl.oauthbearer.metadata.authentication.type?: "none" | "azure_imds"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:728

Type of metadata-based authentication to use for OAUTHBEARER/OIDC azure_imds authenticates using the Azure IMDS endpoint. Sets a default value for sasl.oauthbearer.token.endpoint.url if missing. Configuration values specific of chosen authentication type can be passed through sasl.oauthbearer.config.

Default

none

Inherited from

Omit.sasl.oauthbearer.metadata.authentication.type

sasl.oauthbearer.method?

optional sasl.oauthbearer.method?: "default" | "oidc"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:604

Set to “default” or “oidc” to control which login method to be used. If set to “oidc”, the following properties must also be be specified: sasl.oauthbearer.client.id, sasl.oauthbearer.client.secret, and sasl.oauthbearer.token.endpoint.url.

Default

default

Inherited from

Omit.sasl.oauthbearer.method

sasl.oauthbearer.scope?

optional sasl.oauthbearer.scope?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:629

Client use this to specify the scope of the access request to the broker. Only used when sasl.oauthbearer.method is set to “oidc”.

Inherited from

Omit.sasl.oauthbearer.scope

sasl.oauthbearer.sub.claim.name?

optional sasl.oauthbearer.sub.claim.name?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:646

JWT claim name to use as the subject (principal) when validating OIDC access tokens. Must be present in the JWT payload with a non-empty value. Should match the broker’s sasl.oauthbearer.sub.claim.name configuration for consistent authentication. Only used when sasl.oauthbearer.method is set to “oidc”.

Default

sub

Inherited from

Omit.sasl.oauthbearer.sub.claim.name

sasl.oauthbearer.token.endpoint.url?

optional sasl.oauthbearer.token.endpoint.url?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:639

OAuth/OIDC issuer token endpoint HTTP(S) URI used to retrieve token. Only used when sasl.oauthbearer.method is set to “oidc”.

Inherited from

Omit.sasl.oauthbearer.token.endpoint.url

sasl.password?

optional sasl.password?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:580

SASL password for use with the PLAIN and SASL-SCRAM-.. mechanism

Inherited from

Omit.sasl.password

sasl.username?

optional sasl.username?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:575

SASL username for use with the PLAIN and SASL-SCRAM-.. mechanisms

Inherited from

Omit.sasl.username

security.protocol?

optional security.protocol?: "plaintext" | "ssl" | "sasl_plaintext" | "sasl_ssl"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:385

Protocol used to communicate with brokers.

Default

plaintext

Inherited from

Omit.security.protocol

session.timeout.ms?

optional session.timeout.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:933

Client group session and failure detection timeout. The consumer sends periodic heartbeats (heartbeat.interval.ms) to indicate its liveness to the broker. If no hearts are received by the broker for a group member within the session timeout, the broker will remove the consumer from the group and trigger a rebalance. The allowed range is configured with the broker configuration properties group.min.session.timeout.ms and group.max.session.timeout.ms. session.timeout.ms is not supported for group.protocol=consumer. It is set with the broker configuration property group.consumer.session.timeout.ms by default or can be configured through the AdminClient IncrementalAlterConfigs API. The allowed range is configured with the broker configuration properties group.consumer.min.session.timeout.ms and group.consumer.max.session.timeout.ms. Also see max.poll.interval.ms.

Default

Inherited from

Omit.session.timeout.ms

socket_cb?

optional socket_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:306

Socket creation callback to provide race-free CLOEXEC

Inherited from

Omit.socket_cb

socket.blocking.max.ms?

optional socket.blocking.max.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:143

DEPRECATED No longer used.

Default

Inherited from

Omit.socket.blocking.max.ms

socket.connection.setup.timeout.ms?

optional socket.connection.setup.timeout.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:199

Maximum time allowed for broker connection setup (TCP connection setup as well SSL and SASL handshake). If the connection to the broker is not fully functional after this the connection will be closed and retried.

Default

Inherited from

Omit.socket.connection.setup.timeout.ms

socket.keepalive.enable?

optional socket.keepalive.enable?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:164

Enable TCP keep-alives (SO_KEEPALIVE) on broker sockets

Default

false

Inherited from

Omit.socket.keepalive.enable

socket.max.fails?

optional socket.max.fails?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:178

Disconnect from broker when this number of send failures (e.g., timed out requests) is reached. Disable with 0. WARNING: It is highly recommended to leave this setting at its default value of 1 to avoid the client and broker to become desynchronized in case of request timeouts. NOTE: The connection is automatically re-established.

Default

Inherited from

Omit.socket.max.fails

socket.nagle.disable?

optional socket.nagle.disable?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:171

Disable the Nagle algorithm (TCP_NODELAY) on broker sockets.

Default

true

Inherited from

Omit.socket.nagle.disable

socket.receive.buffer.bytes?

optional socket.receive.buffer.bytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:157

Broker socket receive buffer size. System default is used if 0.

Default

Inherited from

Omit.socket.receive.buffer.bytes

socket.send.buffer.bytes?

optional socket.send.buffer.bytes?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:150

Broker socket send buffer size. System default is used if 0.

Default

Inherited from

Omit.socket.send.buffer.bytes

socket.timeout.ms?

optional socket.timeout.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:136

Default timeout for network requests. Producer: ProduceRequests will use the lesser value of socket.timeout.ms and remaining message.timeout.ms for the first message in the batch. Consumer: FetchRequests will use fetch.wait.max.ms + socket.timeout.ms. Admin: Admin requests will use socket.timeout.ms or explicitly set rd_kafka_AdminOptions_set_operation_timeout() value.

Default

Inherited from

Omit.socket.timeout.ms

ssl_ca?

optional ssl_ca?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:460

CA certificate as set by rd_kafka_conf_set_ssl_cert()

Inherited from

Omit.ssl_ca

ssl_certificate?

optional ssl_certificate?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:435

Client’s public key as set by rd_kafka_conf_set_ssl_cert()

Inherited from

Omit.ssl_certificate

ssl_engine_callback_data?

optional ssl_engine_callback_data?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:504

OpenSSL engine callback data (set with rd_kafka_conf_set_engine_callback_data()).

Inherited from

Omit.ssl_engine_callback_data

ssl_key?

optional ssl_key?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:420

Client’s private key as set by rd_kafka_conf_set_ssl_cert()

Inherited from

Omit.ssl_key

ssl.ca.certificate.stores?

optional ssl.ca.certificate.stores?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:467

Comma-separated list of Windows Certificate stores to load CA certificates from. Certificates will be loaded in the same order as stores are specified. If no certificates can be loaded from any of the specified stores an error is logged and the OpenSSL library’s default CA location is used instead. Store names are typically one or more of: MY, Root, Trust, CA.

Default

Root

Inherited from

Omit.ssl.ca.certificate.stores

ssl.ca.location?

optional ssl.ca.location?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:440

File or directory path to CA certificate(s) for verifying the broker’s key. Defaults: On Windows the system’s CA certificates are automatically looked up in the Windows Root certificate store. On Mac OSX this configuration defaults to probe. It is recommended to install openssl using Homebrew, to provide CA certificates. On Linux install the distribution’s ca-certificates package. If OpenSSL is statically linked or ssl.ca.location is set to probe a list of standard paths will be probed and the first one found will be used as the default CA certificate location path. If OpenSSL is dynamically linked the OpenSSL library’s default path will be used (see OPENSSLDIR in openssl version -a).

Inherited from

Omit.ssl.ca.location

ssl.ca.pem?

optional ssl.ca.pem?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:455

CA certificate string (PEM format) for verifying the broker’s key.

Inherited from

Omit.ssl.ca.pem

ssl.certificate.location?

optional ssl.certificate.location?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:425

Path to client’s public key (PEM) used for authentication.

Inherited from

Omit.ssl.certificate.location

ssl.certificate.pem?

optional ssl.certificate.pem?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:430

Client’s public key string (PEM format) used for authentication.

Inherited from

Omit.ssl.certificate.pem

ssl.certificate.verify_cb?

optional ssl.certificate.verify_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:523

Callback to verify the broker certificate chain.

Inherited from

Omit.ssl.certificate.verify_cb

ssl.cipher.suites?

optional ssl.cipher.suites?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:390

A cipher suite is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. See manual page for ciphers(1) and `SSL_CTX_set_cipher_list(3).

Inherited from

Omit.ssl.cipher.suites

ssl.crl.location?

optional ssl.crl.location?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:472

Path to CRL for verifying broker’s certificate validity.

Inherited from

Omit.ssl.crl.location

ssl.curves.list?

optional ssl.curves.list?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:395

The supported-curves extension in the TLS ClientHello message specifies the curves (standard/named, or ‘explicit’ GF(2^k) or GF(p)) the client is willing to have the server use. See manual page for SSL_CTX_set1_curves_list(3). OpenSSL >= 1.0.2 required.

Inherited from

Omit.ssl.curves.list

ssl.endpoint.identification.algorithm?

optional ssl.endpoint.identification.algorithm?: "none" | "https"

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:518

Endpoint identification algorithm to validate broker hostname using broker certificate. https - Server (broker) hostname verification as specified in RFC2818. none - No endpoint verification. OpenSSL >= 1.0.2 required.

Default

https

Inherited from

Omit.ssl.endpoint.identification.algorithm

ssl.engine.id?

optional ssl.engine.id?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:499

OpenSSL engine id is the name used for loading engine.

Default

dynamic

Inherited from

Omit.ssl.engine.id

ssl.engine.location?

optional ssl.engine.location?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:492

DEPRECATED Path to OpenSSL engine library. OpenSSL >= 1.1.x required. DEPRECATED: OpenSSL engine support is deprecated and should be replaced by OpenSSL 3 providers.

Inherited from

Omit.ssl.engine.location

ssl.key.location?

optional ssl.key.location?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:405

Path to client’s private key (PEM) used for authentication.

Inherited from

Omit.ssl.key.location

ssl.key.password?

optional ssl.key.password?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:410

Private key passphrase (for use with ssl.key.location and set_ssl_cert())

Inherited from

Omit.ssl.key.password

ssl.key.pem?

optional ssl.key.pem?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:415

Client’s private key string (PEM format) used for authentication.

Inherited from

Omit.ssl.key.pem

ssl.keystore.location?

optional ssl.keystore.location?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:477

Path to client’s keystore (PKCS#12) used for authentication.

Inherited from

Omit.ssl.keystore.location

ssl.keystore.password?

optional ssl.keystore.password?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:482

Client’s keystore (PKCS#12) password.

Inherited from

Omit.ssl.keystore.password

ssl.providers?

optional ssl.providers?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:487

Comma-separated list of OpenSSL 3.0.x implementation providers. E.g., “default,legacy”.

Inherited from

Omit.ssl.providers

ssl.sigalgs.list?

optional ssl.sigalgs.list?: string

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:400

The client uses the TLS ClientHello signature_algorithms extension to indicate to the server which signature/hash algorithm pairs may be used in digital signatures. See manual page for SSL_CTX_set1_sigalgs_list(3). OpenSSL >= 1.0.2 required.

Inherited from

Omit.ssl.sigalgs.list

statistics.interval.ms?

optional statistics.interval.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:234

librdkafka statistics emit interval. The application also needs to register a stats callback using rd_kafka_conf_set_stats_cb(). The granularity is 1000ms. A value of 0 disables statistics.

Default

Inherited from

Omit.statistics.interval.ms

stats_cb?

optional stats_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:256

Statistics callback (set with rd_kafka_conf_set_stats_cb())

Inherited from

Omit.stats_cb

throttle_cb?

optional throttle_cb?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:251

Throttle callback (set with rd_kafka_conf_set_throttle_cb())

Inherited from

Omit.throttle_cb

topic.blacklist?

optional topic.blacklist?: any

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:124

Topic blacklist, a comma-separated list of regular expressions for matching topic names that should be ignored in broker metadata information as if the topics did not exist.

Inherited from

Omit.topic.blacklist

topic.metadata.propagation.max.ms?

optional topic.metadata.propagation.max.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:119

Apache Kafka topic creation is asynchronous and it takes some time for a new topic to propagate throughout the cluster to all brokers. If a client requests topic metadata after manual topic creation but before the topic has been fully propagated to the broker the client is requesting metadata from, the topic will seem to be non-existent and the client will mark the topic as such, failing queued produced messages with ERR__UNKNOWN_TOPIC. This setting delays marking a topic as non-existent until the configured propagation max time has passed. The maximum propagation time is calculated from the time the topic is first referenced in the client, e.g., on produce().

Default

Inherited from

Omit.topic.metadata.propagation.max.ms

topic.metadata.refresh.fast.cnt?

optional topic.metadata.refresh.fast.cnt?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:105

DEPRECATED No longer used.

Default

Inherited from

Omit.topic.metadata.refresh.fast.cnt

topic.metadata.refresh.fast.interval.ms?

optional topic.metadata.refresh.fast.interval.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:98

When a topic loses its leader a new metadata request will be enqueued immediately and then with this initial interval, exponentially increasing upto retry.backoff.max.ms, until the topic metadata has been refreshed. If not set explicitly, it will be defaulted to retry.backoff.ms. This is used to recover quickly from transitioning leader brokers.

Default

Inherited from

Omit.topic.metadata.refresh.fast.interval.ms

topic.metadata.refresh.interval.ms?

optional topic.metadata.refresh.interval.ms?: number

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:84

Period of time in milliseconds at which topic and broker metadata is refreshed in order to proactively discover any new brokers, topics, partitions or partition leader changes. Use -1 to disable the intervalled refresh (not recommended). If there are no locally referenced topics (no topic objects created, no messages produced, no subscription or no assignment) then only the broker list will be refreshed every interval but no more often than every 10s.

Default

Inherited from

Omit.topic.metadata.refresh.interval.ms

topic.metadata.refresh.sparse?

optional topic.metadata.refresh.sparse?: boolean

Defined in: node_modules/.pnpm/@confluentinc+kafka-javascript@1.9.0_encoding@0.1.13/node_modules/@confluentinc/kafka-javascript/types/config.d.ts:112

Sparse metadata requests (consumes less network bandwidth)

Default

true

Inherited from

Omit.topic.metadata.refresh.sparse