Variable

SinterErrorCode

The stable string codes carried by SinterError.code. Branch on these rather than on message text.

const SinterErrorCode: {
  readonly ClientClosed: "CLIENT_CLOSED";
  readonly ClientNotConnected: "CLIENT_NOT_CONNECTED";
  readonly ConnectionFailed: "CONNECTION_FAILED";
  readonly ConnectionTimeout: "CONNECTION_TIMEOUT";
  readonly IncompatibleProtocol: "INCOMPATIBLE_PROTOCOL";
  readonly InvalidClientOptions: "INVALID_CLIENT_OPTIONS";
  readonly InvalidConnectionString: "INVALID_CONNECTION_STRING";
  readonly InvalidDocument: "INVALID_DOCUMENT";
  readonly ProtocolViolation: "PROTOCOL_VIOLATION";
  readonly RequestTimeout: "REQUEST_TIMEOUT";
  readonly ServerError: "SERVER_ERROR";
  readonly SocketTimeout: "SOCKET_TIMEOUT";
}

Defined in packages/driver/src/errors.ts:7, packages/driver/src/errors.ts:35

Properties#

ClientClosed

readonly ClientClosed: "CLIENT_CLOSED"

The client has been closed.

Defined in packages/driver/src/errors.ts:15

ClientNotConnected

readonly ClientNotConnected: "CLIENT_NOT_CONNECTED"

A command was sent before connect() completed.

Defined in packages/driver/src/errors.ts:17

ConnectionFailed

readonly ConnectionFailed: "CONNECTION_FAILED"

The connection could not be established or was lost.

Defined in packages/driver/src/errors.ts:19

ConnectionTimeout

readonly ConnectionTimeout: "CONNECTION_TIMEOUT"

Connecting exceeded connectTimeoutMS.

Defined in packages/driver/src/errors.ts:21

IncompatibleProtocol

readonly IncompatibleProtocol: "INCOMPATIBLE_PROTOCOL"

The server does not speak a compatible protocol version.

Defined in packages/driver/src/errors.ts:27

InvalidClientOptions

readonly InvalidClientOptions: "INVALID_CLIENT_OPTIONS"

A client option or a database or collection name is invalid.

Defined in packages/driver/src/errors.ts:11

InvalidConnectionString

readonly InvalidConnectionString: "INVALID_CONNECTION_STRING"

The connection string is malformed.

Defined in packages/driver/src/errors.ts:9

InvalidDocument

readonly InvalidDocument: "INVALID_DOCUMENT"

A request holds a value the driver cannot encode. Nothing was sent.

Defined in packages/driver/src/errors.ts:13

ProtocolViolation

readonly ProtocolViolation: "PROTOCOL_VIOLATION"

The server sent a message the driver cannot interpret.

Defined in packages/driver/src/errors.ts:29

RequestTimeout

readonly RequestTimeout: "REQUEST_TIMEOUT"

A request exceeded requestTimeoutMS.

Defined in packages/driver/src/errors.ts:25

ServerError

readonly ServerError: "SERVER_ERROR"

The server rejected the request. See serverErrorName.

Defined in packages/driver/src/errors.ts:31

SocketTimeout

readonly SocketTimeout: "SOCKET_TIMEOUT"

The connection was idle for longer than socketTimeoutMS.

Defined in packages/driver/src/errors.ts:23

Used by#

SinterErrorCode