~~Class: Reader~~
July 12, 2026 ยท View on GitHub
Class: Reader
Defined in: index.d.ts:430
Deprecated
Use Consumer instead. Reader remains as a compatibility alias in v2.x.
Constructors
Constructor
new Reader(
readerConfig):Reader
Defined in: index.d.ts:437
Parameters
readerConfig
Reader configuration.
Returns
Reader
- Reader instance.
Methods
close()
close():
void
Defined in: index.d.ts:450
Returns
void
- Nothing.
Destructor
Description
Close the reader.
consume()
consume(
consumeConfig):Message[]
Defined in: index.d.ts:444
Parameters
consumeConfig
Consume configuration.
Returns
Message[]
- Messages.
Method
Read messages from Kafka.