> ## Documentation Index
> Fetch the complete documentation index at: https://staging-docs.orderly.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Orderly network net.WS

[Orderly SDKs](/sdks/tech-doc/README) / [Modules](/sdks/tech-doc/modules) / [@orderly.network/net](/sdks/tech-doc/modules/orderly_network_net) / WS

# Class: WS

[@orderly.network/net](/sdks/tech-doc/modules/orderly_network_net).WS

## Table of contents

### Constructors

* [constructor](/sdks/tech-doc/classes/orderly_network_net.WS#constructor)

### Properties

* [\_eventContainer](/sdks/tech-doc/classes/orderly_network_net.WS#_eventcontainer)
* [\_eventHandlers](/sdks/tech-doc/classes/orderly_network_net.WS#_eventhandlers)
* [\_eventPrivateHandlers](/sdks/tech-doc/classes/orderly_network_net.WS#_eventprivatehandlers)
* [\_pendingPrivateSubscribe](/sdks/tech-doc/classes/orderly_network_net.WS#_pendingprivatesubscribe)
* [\_pendingPublicSubscribe](/sdks/tech-doc/classes/orderly_network_net.WS#_pendingpublicsubscribe)
* [\_privateHeartbeatTime](/sdks/tech-doc/classes/orderly_network_net.WS#_privateheartbeattime)
* [\_privateRetryCount](/sdks/tech-doc/classes/orderly_network_net.WS#_privateretrycount)
* [\_publicHeartbeatTime](/sdks/tech-doc/classes/orderly_network_net.WS#_publicheartbeattime)
* [\_publicRetryCount](/sdks/tech-doc/classes/orderly_network_net.WS#_publicretrycount)
* [\_publicSocket](/sdks/tech-doc/classes/orderly_network_net.WS#_publicsocket)
* [authenticated](/sdks/tech-doc/classes/orderly_network_net.WS#authenticated)
* [options](/sdks/tech-doc/classes/orderly_network_net.WS#options)
* [privateIsReconnecting](/sdks/tech-doc/classes/orderly_network_net.WS#privateisreconnecting)
* [privateSocket](/sdks/tech-doc/classes/orderly_network_net.WS#privatesocket)
* [publicIsReconnecting](/sdks/tech-doc/classes/orderly_network_net.WS#publicisreconnecting)
* [reconnectInterval](/sdks/tech-doc/classes/orderly_network_net.WS#reconnectinterval)

### Accessors

* [accountId](/sdks/tech-doc/classes/orderly_network_net.WS#accountid)
* [client](/sdks/tech-doc/classes/orderly_network_net.WS#client)

### Methods

* [authenticate](/sdks/tech-doc/classes/orderly_network_net.WS#authenticate)
* [bindEvents](/sdks/tech-doc/classes/orderly_network_net.WS#bindevents)
* [checkSocketStatus](/sdks/tech-doc/classes/orderly_network_net.WS#checksocketstatus)
* [close](/sdks/tech-doc/classes/orderly_network_net.WS#close)
* [closePrivate](/sdks/tech-doc/classes/orderly_network_net.WS#closeprivate)
* [createPrivateSC](/sdks/tech-doc/classes/orderly_network_net.WS#createprivatesc)
* [createPublicSC](/sdks/tech-doc/classes/orderly_network_net.WS#createpublicsc)
* [emit](/sdks/tech-doc/classes/orderly_network_net.WS#emit)
* [errorBoardscast](/sdks/tech-doc/classes/orderly_network_net.WS#errorboardscast)
* [generateMessage](/sdks/tech-doc/classes/orderly_network_net.WS#generatemessage)
* [getTopicKeyFromMessage](/sdks/tech-doc/classes/orderly_network_net.WS#gettopickeyfrommessage)
* [getTopicKeyFromParams](/sdks/tech-doc/classes/orderly_network_net.WS#gettopickeyfromparams)
* [handlePendingPrivateTopic](/sdks/tech-doc/classes/orderly_network_net.WS#handlependingprivatetopic)
* [off](/sdks/tech-doc/classes/orderly_network_net.WS#off)
* [on](/sdks/tech-doc/classes/orderly_network_net.WS#on)
* [onMessage](/sdks/tech-doc/classes/orderly_network_net.WS#onmessage)
* [onNetworkStatusChange](/sdks/tech-doc/classes/orderly_network_net.WS#onnetworkstatuschange)
* [onOpen](/sdks/tech-doc/classes/orderly_network_net.WS#onopen)
* [onPrivateClose](/sdks/tech-doc/classes/orderly_network_net.WS#onprivateclose)
* [onPrivateError](/sdks/tech-doc/classes/orderly_network_net.WS#onprivateerror)
* [onPrivateMessage](/sdks/tech-doc/classes/orderly_network_net.WS#onprivatemessage)
* [onPrivateOpen](/sdks/tech-doc/classes/orderly_network_net.WS#onprivateopen)
* [onPublicClose](/sdks/tech-doc/classes/orderly_network_net.WS#onpublicclose)
* [onPublicError](/sdks/tech-doc/classes/orderly_network_net.WS#onpublicerror)
* [onPublicMessage](/sdks/tech-doc/classes/orderly_network_net.WS#onpublicmessage)
* [onVisibilityChange](/sdks/tech-doc/classes/orderly_network_net.WS#onvisibilitychange)
* [onceSubscribe](/sdks/tech-doc/classes/orderly_network_net.WS#oncesubscribe)
* [openPrivate](/sdks/tech-doc/classes/orderly_network_net.WS#openprivate)
* [privateSubscribe](/sdks/tech-doc/classes/orderly_network_net.WS#privatesubscribe)
* [reconnectPrivate](/sdks/tech-doc/classes/orderly_network_net.WS#reconnectprivate)
* [reconnectPublic](/sdks/tech-doc/classes/orderly_network_net.WS#reconnectpublic)
* [send](/sdks/tech-doc/classes/orderly_network_net.WS#send)
* [subscribe](/sdks/tech-doc/classes/orderly_network_net.WS#subscribe)
* [unsubscribe](/sdks/tech-doc/classes/orderly_network_net.WS#unsubscribe)
* [unsubscribePrivate](/sdks/tech-doc/classes/orderly_network_net.WS#unsubscribeprivate)
* [unsubscribePublic](/sdks/tech-doc/classes/orderly_network_net.WS#unsubscribepublic)

## Constructors

### constructor

• **new WS**(`options`)

#### Parameters

| Name      | Type        |
| :-------- | :---------- |
| `options` | `WSOptions` |

#### Defined in

[ws/ws.ts:82](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L82)

## Properties

### \_eventContainer

• `Private` **\_eventContainer**: `Map`\<`string`, `Set`\<`Function`>>

#### Defined in

[ws/ws.ts:60](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L60)

***

### \_eventHandlers

• `Private` **\_eventHandlers**: `Map`\<`string`, `Topics`>

#### Defined in

[ws/ws.ts:73](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L73)

***

### \_eventPrivateHandlers

• `Private` **\_eventPrivateHandlers**: `Map`\<`string`, `Topics`>

#### Defined in

[ws/ws.ts:74](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L74)

***

### \_pendingPrivateSubscribe

• `Private` **\_pendingPrivateSubscribe**: `any`\[]\[] = `[]`

#### Defined in

[ws/ws.ts:69](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L69)

***

### \_pendingPublicSubscribe

• `Private` **\_pendingPublicSubscribe**: `any`\[]\[] = `[]`

#### Defined in

[ws/ws.ts:70](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L70)

***

### \_privateHeartbeatTime

• `Private` `Optional` **\_privateHeartbeatTime**: `number`

#### Defined in

[ws/ws.ts:77](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L77)

***

### \_privateRetryCount

• `Private` **\_privateRetryCount**: `number` = `0`

#### Defined in

[ws/ws.ts:80](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L80)

***

### \_publicHeartbeatTime

• `Private` `Optional` **\_publicHeartbeatTime**: `number`

#### Defined in

[ws/ws.ts:76](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L76)

***

### \_publicRetryCount

• `Private` **\_publicRetryCount**: `number` = `0`

#### Defined in

[ws/ws.ts:79](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L79)

***

### \_publicSocket

• `Private` **\_publicSocket**: `WebSocket`

#### Defined in

[ws/ws.ts:57](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L57)

***

### authenticated

• `Private` **authenticated**: `boolean` = `false`

#### Defined in

[ws/ws.ts:67](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L67)

***

### options

• `Private` **options**: `WSOptions`

#### Defined in

[ws/ws.ts:82](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L82)

***

### privateIsReconnecting

• `Private` **privateIsReconnecting**: `boolean` = `false`

#### Defined in

[ws/ws.ts:63](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L63)

***

### privateSocket

• `Private` `Optional` **privateSocket**: `WebSocket`

#### Defined in

[ws/ws.ts:58](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L58)

***

### publicIsReconnecting

• `Private` **publicIsReconnecting**: `boolean` = `false`

#### Defined in

[ws/ws.ts:62](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L62)

***

### reconnectInterval

• `Private` **reconnectInterval**: `number` = `1000`

#### Defined in

[ws/ws.ts:65](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L65)

## Accessors

### accountId

• `set` **accountId**(`accountId`): `void`

#### Parameters

| Name        | Type     |
| :---------- | :------- |
| `accountId` | `string` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:435](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L435)

***

### client

• `get` **client**(): `Object`

#### Returns

`Object`

| Name       | Type        |
| :--------- | :---------- |
| `private?` | `WebSocket` |
| `public`   | `WebSocket` |

#### Defined in

[ws/ws.ts:716](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L716)

## Methods

### authenticate

▸ `Private` **authenticate**(`accountId`): `Promise`\<`void`>

#### Parameters

| Name        | Type     |
| :---------- | :------- |
| `accountId` | `string` |

#### Returns

`Promise`\<`void`>

#### Defined in

[ws/ws.ts:437](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L437)

***

### bindEvents

▸ `Private` **bindEvents**(): `void`

#### Returns

`void`

#### Defined in

[ws/ws.ts:92](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L92)

***

### checkSocketStatus

▸ `Private` **checkSocketStatus**(): `void`

Determine the current connection status,

1. If it is disconnected, reconnect
2. If no message is received for too long, disconnect and reconnect actively
3. When returning from the background and the network status changes, the following process is followed

#### Returns

`void`

#### Defined in

[ws/ws.ts:128](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L128)

***

### close

▸ **close**(): `void`

#### Returns

`void`

#### Defined in

[ws/ws.ts:430](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L430)

***

### closePrivate

▸ **closePrivate**(`code?`, `reason?`): `void`

#### Parameters

| Name      | Type     |
| :-------- | :------- |
| `code?`   | `number` |
| `reason?` | `string` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:184](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L184)

***

### createPrivateSC

▸ `Private` **createPrivateSC**(`options`): `void`

#### Parameters

| Name      | Type        |
| :-------- | :---------- |
| `options` | `WSOptions` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:216](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L216)

***

### createPublicSC

▸ `Private` **createPublicSC**(`options`): `void`

#### Parameters

| Name      | Type        |
| :-------- | :---------- |
| `options` | `WSOptions` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:198](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L198)

***

### emit

▸ **emit**(`eventName`, `message`): `void`

#### Parameters

| Name        | Type     |
| :---------- | :------- |
| `eventName` | `string` |
| `message`   | `any`    |

#### Returns

`void`

#### Defined in

[ws/ws.ts:739](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L739)

***

### errorBoardscast

▸ `Private` **errorBoardscast**(`error`, `eventHandlers`): `void`

#### Parameters

| Name            | Type                       |
| :-------------- | :------------------------- |
| `error`         | `any`                      |
| `eventHandlers` | `Map`\<`string`, `Topics`> |

#### Returns

`void`

#### Defined in

[ws/ws.ts:409](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L409)

***

### generateMessage

▸ `Private` **generateMessage**(`params`, `onUnsubscribe?`, `onMessage?`): \[`MessageParams`, (`event`: `string`) => `any`]

#### Parameters

| Name             | Type                         |
| :--------------- | :--------------------------- |
| `params`         | `any`                        |
| `onUnsubscribe?` | (`event`: `string`) => `any` |
| `onMessage?`     | (`message`: `any`) => `any`  |

#### Returns

\[`MessageParams`, (`event`: `string`) => `any`]

#### Defined in

[ws/ws.ts:655](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L655)

***

### getTopicKeyFromMessage

▸ `Private` **getTopicKeyFromMessage**(`message`): `string`

#### Parameters

| Name      | Type  |
| :-------- | :---- |
| `message` | `any` |

#### Returns

`string`

#### Defined in

[ws/ws.ts:582](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L582)

***

### getTopicKeyFromParams

▸ `Private` **getTopicKeyFromParams**(`params`): `string`

#### Parameters

| Name     | Type  |
| :------- | :---- |
| `params` | `any` |

#### Returns

`string`

#### Defined in

[ws/ws.ts:565](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L565)

***

### handlePendingPrivateTopic

▸ `Private` **handlePendingPrivateTopic**(): `void`

#### Returns

`void`

#### Defined in

[ws/ws.ts:318](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L318)

***

### off

▸ **off**(`eventName`, `callback`): `void`

#### Parameters

| Name        | Type                        |
| :---------- | :-------------------------- |
| `eventName` | `string`                    |
| `callback`  | (`message`: `any`) => `any` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:733](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L733)

***

### on

▸ **on**(`eventName`, `callback`): `void`

#### Parameters

| Name        | Type                        |
| :---------- | :-------------------------- |
| `eventName` | `string`                    |
| `callback`  | (`message`: `any`) => `any` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:726](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L726)

***

### onMessage

▸ `Private` **onMessage**(`event`, `socket`, `handlerMap`): `void`

#### Parameters

| Name         | Type                       |
| :----------- | :------------------------- |
| `event`      | `MessageEvent`\<`any`>     |
| `socket`     | `WebSocket`                |
| `handlerMap` | `Map`\<`string`, `Topics`> |

#### Returns

`void`

#### Defined in

[ws/ws.ts:255](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L255)

***

### onNetworkStatusChange

▸ `Private` **onNetworkStatusChange**(): `void`

#### Returns

`void`

#### Defined in

[ws/ws.ts:116](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L116)

***

### onOpen

▸ `Private` **onOpen**(`event`): `void`

#### Parameters

| Name    | Type    |
| :------ | :------ |
| `event` | `Event` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:231](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L231)

***

### onPrivateClose

▸ `Private` **onPrivateClose**(`event`): `void`

#### Parameters

| Name    | Type         |
| :------ | :----------- |
| `event` | `CloseEvent` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:345](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L345)

***

### onPrivateError

▸ `Private` **onPrivateError**(`event`): `void`

#### Parameters

| Name    | Type    |
| :------ | :------ |
| `event` | `Event` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:389](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L389)

***

### onPrivateMessage

▸ `Private` **onPrivateMessage**(`event`): `void`

#### Parameters

| Name    | Type                   |
| :------ | :--------------------- |
| `event` | `MessageEvent`\<`any`> |

#### Returns

`void`

#### Defined in

[ws/ws.ts:312](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L312)

***

### onPrivateOpen

▸ `Private` **onPrivateOpen**(`event`): `void`

#### Parameters

| Name    | Type    |
| :------ | :------ |
| `event` | `Event` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:246](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L246)

***

### onPublicClose

▸ `Private` **onPublicClose**(`event`): `void`

#### Parameters

| Name    | Type         |
| :------ | :----------- |
| `event` | `CloseEvent` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:327](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L327)

***

### onPublicError

▸ `Private` **onPublicError**(`event`): `void`

#### Parameters

| Name    | Type    |
| :------ | :------ |
| `event` | `Event` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:366](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L366)

***

### onPublicMessage

▸ `Private` **onPublicMessage**(`event`): `void`

#### Parameters

| Name    | Type                   |
| :------ | :--------------------- |
| `event` | `MessageEvent`\<`any`> |

#### Returns

`void`

#### Defined in

[ws/ws.ts:306](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L306)

***

### onVisibilityChange

▸ `Private` **onVisibilityChange**(): `void`

#### Returns

`void`

#### Defined in

[ws/ws.ts:106](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L106)

***

### onceSubscribe

▸ **onceSubscribe**(`params`, `callback`): `void`

#### Parameters

| Name       | Type                                           |
| :--------- | :--------------------------------------------- |
| `params`   | `any`                                          |
| `callback` | `Omit`\<`WSMessageHandler`, `"onUnsubscribe"`> |

#### Returns

`void`

#### Defined in

[ws/ws.ts:603](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L603)

***

### openPrivate

▸ **openPrivate**(`accountId`): `void`

#### Parameters

| Name        | Type     |
| :---------- | :------- |
| `accountId` | `string` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:174](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L174)

***

### privateSubscribe

▸ **privateSubscribe**(`params`, `callback`): () => `void`

#### Parameters

| Name       | Type                                                                 |
| :--------- | :------------------------------------------------------------------- |
| `params`   | `any`                                                                |
| `callback` | `WSMessageHandler` \| `Omit`\<`WSMessageHandler`, `"onUnsubscribe"`> |

#### Returns

`fn`

▸ (): `void`

##### Returns

`void`

#### Defined in

[ws/ws.ts:465](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L465)

***

### reconnectPrivate

▸ `Private` **reconnectPrivate**(): `void`

#### Returns

`void`

#### Defined in

[ws/ws.ts:695](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L695)

***

### reconnectPublic

▸ `Private` **reconnectPublic**(): `void`

#### Returns

`void`

#### Defined in

[ws/ws.ts:679](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L679)

***

### send

▸ **send**(`message`): `void`

#### Parameters

| Name      | Type  |
| :-------- | :---- |
| `message` | `any` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:417](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L417)

***

### subscribe

▸ **subscribe**(`params`, `callback`, `once?`, `id?`): `undefined` | `unsubscribe`

#### Parameters

| Name       | Type                                                                 |
| :--------- | :------------------------------------------------------------------- |
| `params`   | `any`                                                                |
| `callback` | `WSMessageHandler` \| `Omit`\<`WSMessageHandler`, `"onUnsubscribe"`> |
| `once?`    | `boolean`                                                            |
| `id?`      | `string`                                                             |

#### Returns

`undefined` | `unsubscribe`

#### Defined in

[ws/ws.ts:504](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L504)

***

### unsubscribe

▸ `Private` **unsubscribe**(`parmas`, `webSocket`, `handlerMap`): `void`

#### Parameters

| Name         | Type                       |
| :----------- | :------------------------- |
| `parmas`     | `MessageParams`            |
| `webSocket`  | `WebSocket`                |
| `handlerMap` | `Map`\<`string`, `Topics`> |

#### Returns

`void`

#### Defined in

[ws/ws.ts:610](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L610)

***

### unsubscribePrivate

▸ `Private` **unsubscribePrivate**(`parmas`): `void`

#### Parameters

| Name     | Type            |
| :------- | :-------------- |
| `parmas` | `MessageParams` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:647](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L647)

***

### unsubscribePublic

▸ `Private` **unsubscribePublic**(`parmas`): `void`

#### Parameters

| Name     | Type            |
| :------- | :-------------- |
| `parmas` | `MessageParams` |

#### Returns

`void`

#### Defined in

[ws/ws.ts:651](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/net/src/ws/ws.ts#L651)