Class KafkaTimeoutError

Error when a request to a broker times out.

Hierarchy (View Summary)

KafkaConnectionError
- KafkaTimeoutError

Index

Constructors

Properties

broker? name retriable timeoutMs

Methods

Constructors

constructor

new KafkaTimeoutError(
    message: string,
    timeoutMs: number,
    options?: { broker?: string; cause?: unknown },
): KafkaTimeoutError
Parameters
- message: string
- timeoutMs: number
- Optionaloptions: { broker?: string; cause?: unknown }
Returns KafkaTimeoutError
Overrides KafkaConnectionError.constructor
- Defined in errors.ts:95

Properties

`Optional` `Readonly`broker

broker?: string

Broker address that caused the error, if known.

`Readonly`name

name: "KafkaTimeoutError"

`Readonly`retriable

retriable: boolean

Whether this error is retriable (transient).

`Readonly`timeoutMs

timeoutMs: number

Timeout duration in milliseconds.

Methods

`Static`isError

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