Doc reference

Class: WSClient

This class includes all the functionality related to interacting with a Mesh JSON RPC websocket endpoint.

Hierarchy

  • WSClient

Index

Constructors

Methods

Constructors

constructor

+ new WSClient(url: string, wsOpts?: WSOpts): WSClient

Defined in ws_client.ts:252

Instantiates a new WSClient instance

Parameters:

Returns: WSClient

An instance of WSClient

Methods

addOrdersAsync

addOrdersAsync(signedOrders: SignedOrder[], pinned: boolean): Promise<ValidationResults>

Defined in ws_client.ts:281

Adds an array of 0x signed orders to the Mesh node.

Parameters:

Returns: Promise<ValidationResults>

validation results

destroy

destroy(): void

Defined in ws_client.ts:403

destroy unsubscribes all active subscriptions, closes the websocket connection and stops the internal heartbeat connection liveness check.

Returns: void

getOrdersAsync

getOrdersAsync(perPage: number): Promise<GetOrdersResponse>

Defined in ws_client.ts:311

Get all 0x signed orders currently stored in the Mesh node

Parameters:

Returns: Promise<GetOrdersResponse>

all orders, their hash and their fillableTakerAssetAmount

getStatsAsync

getStatsAsync(): Promise<GetStatsResponse>

Defined in ws_client.ts:302

Returns: Promise<GetStatsResponse>

onClose

onClose(cb: function): void

Defined in ws_client.ts:385

Get notified when the underlying WS connection closes normally. If it closes with an error, WSClient automatically attempts to re-connect without emitting a close event.

Parameters:

cb: function

callback to call when WS connection closes

▸ (): void

Returns: void

onReconnected

onReconnected(cb: function): void

Defined in ws_client.ts:394

Get notified when a connection to the underlying WS connection is re-established

Parameters:

cb: function

callback to call with the error when it occurs

▸ (): void

Returns: void

subscribeToOrdersAsync

subscribeToOrdersAsync(cb: function): Promise<string>

Defined in ws_client.ts:345

Subscribe to the 'orders' topic and receive order events from Mesh. This method returns a subscriptionId that can be used to unsubscribe() from this subscription.

Parameters:

cb: function

callback function where you'd like to get notified about order events

▸ (orderEvents: OrderEvent[]): void

Parameters:

Returns: Promise<string>

subscriptionId

unsubscribeAsync

unsubscribeAsync(subscriptionId: string): Promise<void>

Defined in ws_client.ts:375

Unsubscribe from a subscription

Parameters:

Returns: Promise<void>

Enumeration: ContractEventKind

Index

Enumeration members

Enumeration members

ERC1155ApprovalForAllEvent

ERC1155ApprovalForAllEvent: = "ERC1155ApprovalForAllEvent"

Defined in types.ts:222

ERC1155TransferBatchEvent

ERC1155TransferBatchEvent: = "ERC1155TransferBatchEvent"

Defined in types.ts:224

ERC1155TransferSingleEvent

ERC1155TransferSingleEvent: = "ERC1155TransferSingleEvent"

Defined in types.ts:223

ERC20ApprovalEvent

ERC20ApprovalEvent: = "ERC20ApprovalEvent"

Defined in types.ts:218

ERC20TransferEvent

ERC20TransferEvent: = "ERC20TransferEvent"

Defined in types.ts:217

ERC721ApprovalEvent

ERC721ApprovalEvent: = "ERC721ApprovalEvent"

Defined in types.ts:220

ERC721ApprovalForAllEvent

ERC721ApprovalForAllEvent: = "ERC721ApprovalForAllEvent"

Defined in types.ts:221

ERC721TransferEvent

ERC721TransferEvent: = "ERC721TransferEvent"

Defined in types.ts:219

ExchangeCancelEvent

ExchangeCancelEvent: = "ExchangeCancelEvent"

Defined in types.ts:226

ExchangeCancelUpToEvent

ExchangeCancelUpToEvent: = "ExchangeCancelUpToEvent"

Defined in types.ts:227

ExchangeFillEvent

ExchangeFillEvent: = "ExchangeFillEvent"

Defined in types.ts:225

WethDepositEvent

WethDepositEvent: = "WethDepositEvent"

Defined in types.ts:228

WethWithdrawalEvent

WethWithdrawalEvent: = "WethWithdrawalEvent"

Defined in types.ts:229

Enumeration: OrderEventEndState

Index

Enumeration members

Enumeration members

Added

Added: = "ADDED"

Defined in types.ts:286

Cancelled

Cancelled: = "CANCELLED"

Defined in types.ts:289

Expired

Expired: = "EXPIRED"

Defined in types.ts:290

FillabilityIncreased

FillabilityIncreased: = "FILLABILITY_INCREASED"

Defined in types.ts:294

Filled

Filled: = "FILLED"

Defined in types.ts:287

FullyFilled

FullyFilled: = "FULLY_FILLED"

Defined in types.ts:288

Invalid

Invalid: = "INVALID"

Defined in types.ts:285

StoppedWatching

StoppedWatching: = "STOPPED_WATCHING"

Defined in types.ts:292

Unexpired

Unexpired: = "UNEXPIRED"

Defined in types.ts:291

Unfunded

Unfunded: = "UNFUNDED"

Defined in types.ts:293

Enumeration: RejectedCode

Index

Enumeration members

Enumeration members

InternalError

InternalError: = "InternalError"

Defined in types.ts:358

MaxOrderSizeExceeded

MaxOrderSizeExceeded: = "MaxOrderSizeExceeded"

Defined in types.ts:359

NetworkRequestFailed

NetworkRequestFailed: = "NetworkRequestFailed"

Defined in types.ts:362

OrderAlreadyStored

OrderAlreadyStored: = "OrderAlreadyStored"

Defined in types.ts:360

OrderCancelled

OrderCancelled: = "OrderCancelled"

Defined in types.ts:367

OrderExpired

OrderExpired: = "OrderExpired"

Defined in types.ts:365

OrderForIncorrectChain

OrderForIncorrectChain: = "OrderForIncorrectChain"

Defined in types.ts:361

OrderFullyFilled

OrderFullyFilled: = "OrderFullyFilled"

Defined in types.ts:366

OrderHasInvalidMakerAssetAmount

OrderHasInvalidMakerAssetAmount: = "OrderHasInvalidMakerAssetAmount"

Defined in types.ts:363

OrderHasInvalidMakerAssetData

OrderHasInvalidMakerAssetData: = "OrderHasInvalidMakerAssetData"

Defined in types.ts:369

OrderHasInvalidSignature

OrderHasInvalidSignature: = "OrderHasInvalidSignature"

Defined in types.ts:371

OrderHasInvalidTakerAssetAmount

OrderHasInvalidTakerAssetAmount: = "OrderHasInvalidTakerAssetAmount"

Defined in types.ts:364

OrderHasInvalidTakerAssetData

OrderHasInvalidTakerAssetData: = "OrderHasInvalidTakerAssetData"

Defined in types.ts:370

OrderUnfunded

OrderUnfunded: = "OrderUnfunded"

Defined in types.ts:368

Enumeration: RejectedKind

Index

Enumeration members

Enumeration members

MeshError

MeshError: = "MESH_ERROR"

Defined in types.ts:353

MeshValidation

MeshValidation: = "MESH_VALIDATION"

Defined in types.ts:354

ZeroexValidation

ZeroexValidation: = "ZEROEX_VALIDATION"

Defined in types.ts:352

Interface: AcceptedOrderInfo

Hierarchy

  • AcceptedOrderInfo

Index

Properties

Properties

fillableTakerAssetAmount

fillableTakerAssetAmount: BigNumber

Defined in types.ts:335

isNew

isNew: boolean

Defined in types.ts:336

orderHash

orderHash: string

Defined in types.ts:333

signedOrder

signedOrder: SignedOrder

Defined in types.ts:334

Interface: ClientConfig

WebSocketClient configs Source: https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md#client-config-options

Hierarchy

  • ClientConfig

Index

Properties

Properties

Optional assembleFragments

assembleFragments? : undefined | false | true

Defined in types.ts:16

Optional closeTimeout

closeTimeout? : undefined | number

Defined in types.ts:17

Optional fragmentOutgoingMessages

fragmentOutgoingMessages? : undefined | false | true

Defined in types.ts:14

Optional fragmentationThreshold

fragmentationThreshold? : undefined | number

Defined in types.ts:15

Optional maxReceivedFrameSize

maxReceivedFrameSize? : undefined | number

Defined in types.ts:12

Optional maxReceivedMessageSize

maxReceivedMessageSize? : undefined | number

Defined in types.ts:13

Optional tlsOptions

tlsOptions? : any

Defined in types.ts:18

Optional webSocketVersion

webSocketVersion? : undefined | number

Defined in types.ts:11

Interface: ContractEvent

Hierarchy

  • ContractEvent

Index

Properties

Properties

address

address: string

Defined in types.ts:279

blockHash

blockHash: string

Defined in types.ts:274

isRemoved

isRemoved: string

Defined in types.ts:278

kind

kind: ContractEventKind

Defined in types.ts:280

logIndex

logIndex: number

Defined in types.ts:277

parameters

parameters: ContractEventParameters

Defined in types.ts:281

txHash

txHash: string

Defined in types.ts:275

txIndex

txIndex: number

Defined in types.ts:276

Interface: ERC1155ApprovalForAllEvent

Hierarchy

  • ERC1155ApprovalForAllEvent

Index

Properties

Properties

approved

approved: boolean

Defined in types.ts:144

operator

operator: string

Defined in types.ts:143

owner

owner: string

Defined in types.ts:142

Interface: ERC1155TransferBatchEvent

Hierarchy

  • ERC1155TransferBatchEvent

Index

Properties

Properties

from

from: string

Defined in types.ts:127

ids

ids: BigNumber[]

Defined in types.ts:129

operator

operator: string

Defined in types.ts:126

to

to: string

Defined in types.ts:128

values

values: BigNumber[]

Defined in types.ts:130

Interface: ERC1155TransferSingleEvent

Hierarchy

  • ERC1155TransferSingleEvent

Index

Properties

Properties

from

from: string

Defined in types.ts:111

id

id: BigNumber

Defined in types.ts:113

operator

operator: string

Defined in types.ts:110

to

to: string

Defined in types.ts:112

value

value: BigNumber

Defined in types.ts:114

Interface: ERC20ApprovalEvent

Hierarchy

  • ERC20ApprovalEvent

Index

Properties

Properties

owner

owner: string

Defined in types.ts:68

spender

spender: string

Defined in types.ts:69

value

value: BigNumber

Defined in types.ts:70

Interface: ERC20TransferEvent

Hierarchy

  • ERC20TransferEvent

Index

Properties

Properties

from

from: string

Defined in types.ts:56

to

to: string

Defined in types.ts:57

value

value: BigNumber

Defined in types.ts:58

Interface: ERC721ApprovalEvent

Hierarchy

  • ERC721ApprovalEvent

Index

Properties

Properties

approved

approved: string

Defined in types.ts:93

owner

owner: string

Defined in types.ts:92

tokenId

tokenId: BigNumber

Defined in types.ts:94

Interface: ERC721ApprovalForAllEvent

Hierarchy

  • ERC721ApprovalForAllEvent

Index

Properties

Properties

approved

approved: boolean

Defined in types.ts:106

operator

operator: string

Defined in types.ts:105

owner

owner: string

Defined in types.ts:104

Interface: ERC721TransferEvent

Hierarchy

  • ERC721TransferEvent

Index

Properties

Properties

from

from: string

Defined in types.ts:80

to

to: string

Defined in types.ts:81

tokenId

tokenId: BigNumber

Defined in types.ts:82

Interface: ExchangeCancelEvent

Hierarchy

  • ExchangeCancelEvent

Index

Properties

Properties

feeRecipientAddress

feeRecipientAddress: string

Defined in types.ts:178

makerAddress

makerAddress: string

Defined in types.ts:176

makerAssetData

makerAssetData: string

Defined in types.ts:180

orderHash

orderHash: string

Defined in types.ts:179

senderAddress

senderAddress: string

Defined in types.ts:177

takerAssetData

takerAssetData: string

Defined in types.ts:181

Interface: ExchangeCancelUpToEvent

Hierarchy

  • ExchangeCancelUpToEvent

Index

Properties

Properties

makerAddress

makerAddress: string

Defined in types.ts:185

orderEpoch

orderEpoch: BigNumber

Defined in types.ts:187

senderAddress

senderAddress: string

Defined in types.ts:186

Interface: ExchangeFillEvent

Hierarchy

  • ExchangeFillEvent

Index

Properties

Properties

feeRecipientAddress

feeRecipientAddress: string

Defined in types.ts:151

makerAddress

makerAddress: string

Defined in types.ts:148

makerAssetData

makerAssetData: string

Defined in types.ts:157

makerAssetFilledAmount

makerAssetFilledAmount: BigNumber

Defined in types.ts:152

makerFeePaid

makerFeePaid: BigNumber

Defined in types.ts:154

orderHash

orderHash: string

Defined in types.ts:156

senderAddress

senderAddress: string

Defined in types.ts:150

takerAddress

takerAddress: string

Defined in types.ts:149

takerAssetData

takerAssetData: string

Defined in types.ts:158

takerAssetFilledAmount

takerAssetFilledAmount: BigNumber

Defined in types.ts:153

takerFeePaid

takerFeePaid: BigNumber

Defined in types.ts:155

Interface: GetOrdersResponse

Hierarchy

  • GetOrdersResponse

Index

Properties

Properties

ordersInfos

ordersInfos: OrderInfo[]

Defined in types.ts:415

snapshotID

snapshotID: string

Defined in types.ts:413

snapshotTimestamp

snapshotTimestamp: number

Defined in types.ts:414

Interface: GetStatsResponse

Hierarchy

  • GetStatsResponse

Index

Properties

Properties

ethRPCRateLimitExpiredRequests

ethRPCRateLimitExpiredRequests: number

Defined in types.ts:442

ethRPCRequestsSentInCurrentUTCDay

ethRPCRequestsSentInCurrentUTCDay: number

Defined in types.ts:441

ethereumChainID

ethereumChainID: number

Defined in types.ts:433

latestBlock

latestBlock: LatestBlock

Defined in types.ts:434

maxExpirationTime

maxExpirationTime: string

Defined in types.ts:439

numOrders

numOrders: number

Defined in types.ts:436

numOrdersIncludingRemoved

numOrdersIncludingRemoved: number

Defined in types.ts:437

numPeers

numPeers: number

Defined in types.ts:435

numPinnedOrders

numPinnedOrders: number

Defined in types.ts:438

peerID

peerID: string

Defined in types.ts:432

pubSubTopic

pubSubTopic: string

Defined in types.ts:430

rendezvous

rendezvous: string

Defined in types.ts:431

startOfCurrentUTCDay

startOfCurrentUTCDay: string

Defined in types.ts:440

version

version: string

Defined in types.ts:429

Interface: HeartbeatEventPayload

Hierarchy

  • HeartbeatEventPayload

Index

Properties

Properties

result

result: string

Defined in types.ts:304

subscription

subscription: string

Defined in types.ts:303

Interface: LatestBlock

Hierarchy

  • LatestBlock

Index

Properties

Properties

hash

hash: string

Defined in types.ts:425

number

number: number

Defined in types.ts:424

Interface: OrderEvent

Hierarchy

  • OrderEvent

Index

Properties

Properties

contractEvents

contractEvents: ContractEvent[]

Defined in types.ts:322

endState

endState: OrderEventEndState

Defined in types.ts:320

fillableTakerAssetAmount

fillableTakerAssetAmount: BigNumber

Defined in types.ts:321

orderHash

orderHash: string

Defined in types.ts:318

signedOrder

signedOrder: SignedOrder

Defined in types.ts:319

timestampMs

timestampMs: number

Defined in types.ts:317

Interface: OrderEventPayload

Hierarchy

  • OrderEventPayload

Index

Properties

Properties

result

result: RawOrderEvent[]

Defined in types.ts:299

subscription

subscription: string

Defined in types.ts:298

Interface: OrderInfo

Hierarchy

  • OrderInfo

Index

Properties

Properties

fillableTakerAssetAmount

fillableTakerAssetAmount: BigNumber

Defined in types.ts:348

orderHash

orderHash: string

Defined in types.ts:346

signedOrder

signedOrder: SignedOrder

Defined in types.ts:347

Interface: RawAcceptedOrderInfo

Hierarchy

  • RawAcceptedOrderInfo

Index

Properties

Properties

fillableTakerAssetAmount

fillableTakerAssetAmount: string

Defined in types.ts:328

isNew

isNew: boolean

Defined in types.ts:329

orderHash

orderHash: string

Defined in types.ts:326

signedOrder

signedOrder: StringifiedSignedOrder

Defined in types.ts:327

Interface: RawGetOrdersResponse

Hierarchy

  • RawGetOrdersResponse

Index

Properties

Properties

ordersInfos

ordersInfos: RawAcceptedOrderInfo[]

Defined in types.ts:406

snapshotID

snapshotID: string

Defined in types.ts:404

snapshotTimestamp

snapshotTimestamp: string

Defined in types.ts:405

Interface: RawOrderEvent

Hierarchy

  • RawOrderEvent

Index

Properties

Properties

contractEvents

contractEvents: StringifiedContractEvent[]

Defined in types.ts:313

endState

endState: OrderEventEndState

Defined in types.ts:311

fillableTakerAssetAmount

fillableTakerAssetAmount: string

Defined in types.ts:312

orderHash

orderHash: string

Defined in types.ts:309

signedOrder

signedOrder: StringifiedSignedOrder

Defined in types.ts:310

timestamp

timestamp: string

Defined in types.ts:308

Interface: RawOrderInfo

Hierarchy

  • RawOrderInfo

Index

Properties

Properties

fillableTakerAssetAmount

fillableTakerAssetAmount: string

Defined in types.ts:342

orderHash

orderHash: string

Defined in types.ts:340

signedOrder

signedOrder: StringifiedSignedOrder

Defined in types.ts:341

Interface: RawRejectedOrderInfo

Hierarchy

  • RawRejectedOrderInfo

Index

Properties

Properties

kind

kind: RejectedKind

Defined in types.ts:382

orderHash

orderHash: string

Defined in types.ts:380

signedOrder

signedOrder: StringifiedSignedOrder

Defined in types.ts:381

status

status: RejectedStatus

Defined in types.ts:383

Interface: RawValidationResults

Hierarchy

  • RawValidationResults

Index

Properties

Properties

accepted

accepted: RawAcceptedOrderInfo[]

Defined in types.ts:394

rejected

rejected: RawRejectedOrderInfo[]

Defined in types.ts:395

Interface: RejectedOrderInfo

Hierarchy

  • RejectedOrderInfo

Index

Properties

Properties

kind

kind: RejectedKind

Defined in types.ts:389

orderHash

orderHash: string

Defined in types.ts:387

signedOrder

signedOrder: SignedOrder

Defined in types.ts:388

status

status: RejectedStatus

Defined in types.ts:390

Interface: RejectedStatus

Hierarchy

  • RejectedStatus

Index

Properties

Properties

code

code: RejectedCode

Defined in types.ts:375

message

message: string

Defined in types.ts:376

Interface: StringifiedContractEvent

Hierarchy

  • StringifiedContractEvent

Index

Properties

Properties

address

address: string

Defined in types.ts:253

blockHash

blockHash: string

Defined in types.ts:248

isRemoved

isRemoved: string

Defined in types.ts:252

kind

kind: string

Defined in types.ts:254

logIndex

logIndex: number

Defined in types.ts:251

parameters

parameters: StringifiedContractEventParameters

Defined in types.ts:255

txHash

txHash: string

Defined in types.ts:249

txIndex

txIndex: number

Defined in types.ts:250

Interface: StringifiedERC1155TransferBatchEvent

Hierarchy

  • StringifiedERC1155TransferBatchEvent

Index

Properties

Properties

from

from: string

Defined in types.ts:135

ids

ids: string[]

Defined in types.ts:137

operator

operator: string

Defined in types.ts:134

to

to: string

Defined in types.ts:136

values

values: string[]

Defined in types.ts:138

Interface: StringifiedERC1155TransferSingleEvent

Hierarchy

  • StringifiedERC1155TransferSingleEvent

Index

Properties

Properties

from

from: string

Defined in types.ts:119

id

id: string

Defined in types.ts:121

operator

operator: string

Defined in types.ts:118

to

to: string

Defined in types.ts:120

value

value: string

Defined in types.ts:122

Interface: StringifiedERC20ApprovalEvent

Hierarchy

  • StringifiedERC20ApprovalEvent

Index

Properties

Properties

owner

owner: string

Defined in types.ts:74

spender

spender: string

Defined in types.ts:75

value

value: string

Defined in types.ts:76

Interface: StringifiedERC20TransferEvent

Hierarchy

  • StringifiedERC20TransferEvent

Index

Properties

Properties

from

from: string

Defined in types.ts:62

to

to: string

Defined in types.ts:63

value

value: string

Defined in types.ts:64

Interface: StringifiedERC721ApprovalEvent

Hierarchy

  • StringifiedERC721ApprovalEvent

Index

Properties

Properties

approved

approved: string

Defined in types.ts:99

owner

owner: string

Defined in types.ts:98

tokenId

tokenId: string

Defined in types.ts:100

Interface: StringifiedERC721TransferEvent

Hierarchy

  • StringifiedERC721TransferEvent

Index

Properties

Properties

from

from: string

Defined in types.ts:86

to

to: string

Defined in types.ts:87

tokenId

tokenId: string

Defined in types.ts:88

Interface: StringifiedExchangeCancelUpToEvent

Hierarchy

  • StringifiedExchangeCancelUpToEvent

Index

Properties

Properties

makerAddress

makerAddress: string

Defined in types.ts:191

orderEpoch

orderEpoch: string

Defined in types.ts:193

senderAddress

senderAddress: string

Defined in types.ts:192

Interface: StringifiedExchangeFillEvent

Hierarchy

  • StringifiedExchangeFillEvent

Index

Properties

Properties

feeRecipientAddress

feeRecipientAddress: string

Defined in types.ts:165

makerAddress

makerAddress: string

Defined in types.ts:162

makerAssetData

makerAssetData: string

Defined in types.ts:171

makerAssetFilledAmount

makerAssetFilledAmount: string

Defined in types.ts:166

makerFeePaid

makerFeePaid: string

Defined in types.ts:168

orderHash

orderHash: string

Defined in types.ts:170

senderAddress

senderAddress: string

Defined in types.ts:164

takerAddress

takerAddress: string

Defined in types.ts:163

takerAssetData

takerAssetData: string

Defined in types.ts:172

takerAssetFilledAmount

takerAssetFilledAmount: string

Defined in types.ts:167

takerFeePaid

takerFeePaid: string

Defined in types.ts:169

Interface: StringifiedSignedOrder

Hierarchy

  • StringifiedSignedOrder

Index

Properties

Properties

exchangeAddress

exchangeAddress: string

Defined in types.ts:49

expirationTimeSeconds

expirationTimeSeconds: string

Defined in types.ts:51

feeRecipientAddress

feeRecipientAddress: string

Defined in types.ts:50

makerAddress

makerAddress: string

Defined in types.ts:40

makerAssetAmount

makerAssetAmount: string

Defined in types.ts:44

makerAssetData

makerAssetData: string

Defined in types.ts:46

makerFee

makerFee: string

Defined in types.ts:42

salt

salt: string

Defined in types.ts:48

senderAddress

senderAddress: string

Defined in types.ts:39

signature

signature: string

Defined in types.ts:52

takerAddress

takerAddress: string

Defined in types.ts:41

takerAssetAmount

takerAssetAmount: string

Defined in types.ts:45

takerAssetData

takerAssetData: string

Defined in types.ts:47

takerFee

takerFee: string

Defined in types.ts:43

Interface: StringifiedWethDepositEvent

Hierarchy

  • StringifiedWethDepositEvent

Index

Properties

Properties

owner

owner: string

Defined in types.ts:212

value

value: string

Defined in types.ts:213

Interface: StringifiedWethWithdrawalEvent

Hierarchy

  • StringifiedWethWithdrawalEvent

Index

Properties

Properties

owner

owner: string

Defined in types.ts:202

value

value: string

Defined in types.ts:203

Interface: ValidationResults

Hierarchy

  • ValidationResults

Index

Properties

Properties

accepted

accepted: AcceptedOrderInfo[]

Defined in types.ts:399

rejected

rejected: RejectedOrderInfo[]

Defined in types.ts:400

Interface: WethDepositEvent

Hierarchy

  • WethDepositEvent

Index

Properties

Properties

owner

owner: string

Defined in types.ts:207

value

value: BigNumber

Defined in types.ts:208

Interface: WethWithdrawalEvent

Hierarchy

  • WethWithdrawalEvent

Index

Properties

Properties

owner

owner: string

Defined in types.ts:197

value

value: BigNumber

Defined in types.ts:198

Interface: WSMessage

Hierarchy

  • WSMessage

Index

Properties

Properties

type

type: string

Defined in types.ts:419

utf8Data

utf8Data: string

Defined in types.ts:420

Interface: WSOpts

timeout: timeout in milliseconds to enforce on every WS request that expects a response headers: Request headers (e.g., authorization) protocol: requestOptions should be either null or an object specifying additional configuration options to be passed to http.request or https.request. This can be used to pass a custom agent to enable WebSocketClient usage from behind an HTTP or HTTPS proxy server using koichik/node-tunnel or similar. clientConfig: The client configs documented here: https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md reconnectDelay: time in milliseconds after which to attempt to reconnect to WS server after an error occurred (default: 5000)

Hierarchy

  • WSOpts

Index

Properties

Properties

Optional clientConfig

clientConfig? : ClientConfig

Defined in types.ts:34

Optional headers

headers? : undefined | __type

Defined in types.ts:32

Optional protocol

protocol? : undefined | string

Defined in types.ts:33

Optional reconnectDelay

reconnectDelay? : undefined | number

Defined in types.ts:35

Optional timeout

timeout? : undefined | number

Defined in types.ts:31

Last updated