ConnectionConfig

Defined in: index.ts:7

Properties

acceptUnmaskedFrames?

optional acceptUnmaskedFrames: boolean

Defined in: index.ts:35

When set to true, the server will accept and handle unmasked frames from the client. According to the RFC 6455, the server must close the connection to the client in such cases, however it seems like there are some popular libraries that are sending unmasked frames, ignoring the RFC. By default this option is set to false, i.e. according to RFC 6455.

---

headers?

optional headers: HeadersInit

Defined in: index.ts:39

Additional connect request headers.

---

maxFrameSize?

optional maxFrameSize: number | "none"

Defined in: index.ts:31

The maximum size of a single incoming message frame. The string “none” means no size limit. The limit is for frame payload NOT including the frame header. The default value is 16 MiB which should be reasonably big for all normal use-cases but small enough to prevent memory eating by a malicious user.

---

maxMessageSize?

optional maxMessageSize: number | "none"

Defined in: index.ts:27

The maximum size of an incoming message. The string “none” means no size limit. The default value is 64 MiB which should be reasonably big for all normal use-cases but small enough to prevent memory eating by a malicious user.

---

maxWriteBufferSize?

optional maxWriteBufferSize: number

Defined in: index.ts:23

The max size of the write buffer in bytes. Setting this can provide backpressure in the case the write buffer is filling up due to write errors. The default value is unlimited.

Note: The write buffer only builds up past write_buffer_size when writes to the underlying stream are failing. So the write buffer can not fill up if you are not observing write errors.

Note: Should always be at least write_buffer_size + 1 message and probably a little more depending on error handling strategy.

---

readBufferSize?

optional readBufferSize: number

Defined in: index.ts:11

Read buffer capacity. The default value is 128 KiB.

---

writeBufferSize?

optional writeBufferSize: number

Defined in: index.ts:16

The target minimum size of the write buffer to reach before writing the data to the underlying stream. The default value is 128 KiB.

If set to 0 each message will be eagerly written to the underlying stream. It is often more optimal to allow them to buffer a little, hence the default value.