Class KafkaProtocolError

Error returned by a Kafka broker in a protocol response. Maps to the error codes defined in the Kafka protocol spec.

Hierarchy (View Summary)

KafkaError
- KafkaProtocolError

Index

Constructors

Properties

errorCode name retriable

Methods

Constructors

constructor

new KafkaProtocolError(
    message: string,
    errorCode: number,
    retriable: boolean,
    options?: ErrorOptions,
): KafkaProtocolError
Parameters
- message: string
- errorCode: number
- retriable: boolean
- Optionaloptions: ErrorOptions
Returns KafkaProtocolError
Overrides KafkaError.constructor
- Defined in errors.ts:46

Properties

`Readonly`errorCode

errorCode: number

Kafka protocol error code (e.g. 1 = OFFSET_OUT_OF_RANGE).

`Readonly`name

name: "KafkaProtocolError"

`Readonly`retriable

retriable: boolean

Whether this error is retriable (transient).

Methods

`Static`isError

isError(error: unknown): error is KafkaProtocolError
Check if a value is an instance of Error
Parameters
- error: unknown
Returns error is KafkaProtocolError
True if the value is an instance of Error, false otherwise
Overrides KafkaError.isError
- Defined in errors.ts:51