Class KafkaConnectionError

Error related to network connectivity or socket operations.

Hierarchy (View Summary)

KafkaError
- KafkaConnectionError
  - KafkaTimeoutError

Index

Constructors

Properties

broker? name retriable

Methods

Constructors

constructor

new KafkaConnectionError(
message: string,
options?: { broker?: string; cause?: unknown; retriable?: boolean },
): KafkaConnectionError
Parameters
- message: string
- Optionaloptions: { broker?: string; cause?: unknown; retriable?: boolean }
Returns KafkaConnectionError
Overrides KafkaError.constructor
- Defined in errors.ts:69

Properties

`Optional` `Readonly`broker

broker?: string

Broker address that caused the error, if known.

`Readonly`name

name: string = "KafkaConnectionError"

`Readonly`retriable

retriable: boolean

Whether this error is retriable (transient).

Methods

`Static`isError

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