uWebSockets.js v16.3.0 documentation

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

CompressOptions

CompressOptions: number

WebSocket compression options

RecognizedString

RecognizedString: string | ArrayBuffer | Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array

Recognized string types, things C++ can read and understand as strings

Variables

DEDICATED_COMPRESSOR

DEDICATED_COMPRESSOR: CompressOptions

Sliding dedicated compress window, requires lots of memory per socket

DISABLED

DISABLED: CompressOptions

No compression (always a good idea)

SHARED_COMPRESSOR

SHARED_COMPRESSOR: CompressOptions

Zero memory overhead compression (recommended)

Functions

App

App(options?: AppOptions): TemplatedApp

- Defined in index.d.ts:161
Constructs a non-SSL app

Parameters
- Optional options: AppOptions
Returns TemplatedApp

SSLApp

SSLApp(options: AppOptions): TemplatedApp

- Defined in index.d.ts:164
Constructs an SSL app

Parameters
- options: AppOptions
Returns TemplatedApp

us_listen_socket_close

us_listen_socket_close(listenSocket: us_listen_socket): void

- Defined in index.d.ts:167
Closes a uSockets listen socket.

Parameters
- listenSocket: us_listen_socket
Returns void

Generated using TypeDoc