Class SchemaRegistryError

Error from the Schema Registry.

Wraps HTTP and Schema Registry API errors with the registry error code when available.

Hierarchy (View Summary)

KafkaError
- SchemaRegistryError

Index

Constructors

Properties

errorCode? name retriable statusCode?

Methods

Constructors

constructor

new SchemaRegistryError(
    message: string,
    options?: {
        cause?: unknown;
        errorCode?: number;
        retriable?: boolean;
        statusCode?: number;
    },
): SchemaRegistryError
Parameters
- message: string
- Optionaloptions: {
      cause?: unknown;
      errorCode?: number;
      retriable?: boolean;
      statusCode?: number;
  }
Returns SchemaRegistryError
Overrides KafkaError.constructor
- Defined in serialization/schema-registry.ts:111

Properties

`Optional` `Readonly`errorCode

errorCode?: number

Schema Registry error code (e.g. 40401 = subject not found).

`Readonly`name

name: "SchemaRegistryError"

`Readonly`retriable

retriable: boolean

Whether this error is retriable (transient).

`Optional` `Readonly`statusCode

statusCode?: number

HTTP status code from the response.

Methods

`Static`isError

isError(error: unknown): error is SchemaRegistryError
Check if a value is an instance of Error
Parameters
- error: unknown
Returns error is SchemaRegistryError
True if the value is an instance of Error, false otherwise
Overrides KafkaError.isError
- Defined in serialization/schema-registry.ts:124