Interface: ConsumeConfig

July 18, 2026 ยท View on GitHub

xk6-kafka


Interface: ConsumeConfig

Defined in: index.d.ts:226

Configuration for Consume method.

Properties

expectTimeout

expectTimeout: boolean

Defined in: index.d.ts:237

If true, return whatever messages have been collected when maxWait is passed.


limit?

optional limit?: number

Defined in: index.d.ts:228

collect this many messages before returning.


maxMessages?

optional maxMessages?: number

Defined in: index.d.ts:230

preferred v2 alias for limit.


nanoPrecision

nanoPrecision: boolean

Defined in: index.d.ts:232

If true, returned message RFC3339 timestamps carry nanosecond precision.