# WebSocketSessionError

URL: https://www.caprid.com/docs/reference/typescript/caprid/relay-websocket/classes/websocketsessionerror/

Defined in: [relay-sdks/ts/packages/relay-websocket/src/errors.ts:16](https://github.com/caprids/relay-sdks/blob/main/ts/packages/relay-websocket/src/errors.ts#L16)

A session failure (TA-22): the session is over, or the dial failed.

## Extends

- `Error`

## Constructors

### Constructor

```ts
new WebSocketSessionError(message, options?): WebSocketSessionError;
```

Defined in: [relay-sdks/ts/packages/relay-websocket/src/errors.ts:26](https://github.com/caprids/relay-sdks/blob/main/ts/packages/relay-websocket/src/errors.ts#L26)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `message` | `string` |
| `options?` | \{ `cause?`: `unknown`; `close?`: [`CloseInfo`](https://www.caprid.com/docs/reference/typescript/caprid/relay-websocket/interfaces/closeinfo/); \} |
| `options.cause?` | `unknown` |
| `options.close?` | [`CloseInfo`](https://www.caprid.com/docs/reference/typescript/caprid/relay-websocket/interfaces/closeinfo/) |

#### Returns

`WebSocketSessionError`

#### Overrides

`Error.constructor`

## Properties

### cause?

```ts
cause?: unknown;
```

Defined in: typescript/lib/lib.es2022.error.d.ts:24

#### Inherited from

`Error.cause`

***

### closeCode?

```ts
readonly closeCode?: number;
```

Defined in: [relay-sdks/ts/packages/relay-websocket/src/errors.ts:22](https://github.com/caprids/relay-sdks/blob/main/ts/packages/relay-websocket/src/errors.ts#L22)

The peer's application close code, when the peer closed the session (TA-24).

***

### message

```ts
message: string;
```

Defined in: typescript/lib/lib.es5.d.ts:1075

#### Inherited from

`Error.message`

***

### name

```ts
readonly name: "WebSocketSessionError" = 'WebSocketSessionError';
```

Defined in: [relay-sdks/ts/packages/relay-websocket/src/errors.ts:18](https://github.com/caprids/relay-sdks/blob/main/ts/packages/relay-websocket/src/errors.ts#L18)

Always `'WebSocketSessionError'`; not part of the contract, which classifies by `source`.

#### Overrides

`Error.name`

***

### reason?

```ts
readonly reason?: string;
```

Defined in: [relay-sdks/ts/packages/relay-websocket/src/errors.ts:24](https://github.com/caprids/relay-sdks/blob/main/ts/packages/relay-websocket/src/errors.ts#L24)

The peer's close reason, when the peer closed the session (TA-24).

***

### source

```ts
readonly source: "session" = 'session';
```

Defined in: [relay-sdks/ts/packages/relay-websocket/src/errors.ts:20](https://github.com/caprids/relay-sdks/blob/main/ts/packages/relay-websocket/src/errors.ts#L20)

Always `'session'`.

***

### stack?

```ts
stack?: string;
```

Defined in: typescript/lib/lib.es5.d.ts:1076

#### Inherited from

`Error.stack`