@morojs/moro

@morojs/moro / WebSocketAdapterOptions

Interface: WebSocketAdapterOptions

Defined in: src/core/networking/websocket-adapter.ts:4

Indexable

[key: string]: any

Properties

compression?

optional compression?: boolean

Defined in: src/core/networking/websocket-adapter.ts:5

cors?

optional cors?: object

Defined in: src/core/networking/websocket-adapter.ts:6

credentials?

optional credentials?: boolean

methods?

optional methods?: string[]

origin?

optional origin?: string | boolean | RegExp | string[] | ((requestOrigin, callback?) => string | boolean | void)

Allowed origin(s) for cross-origin WebSocket upgrades.

• undefined / true / '*' — allow any origin
• false — same-origin only
• string / string[] — exact origin(s)
• RegExp — matched origin (Socket.IO)
• function — dynamic: the ws adapter calls it (requestOrigin) => boolean | string (return true/'*' to allow, false to deny, or the allowed origin string); the Socket.IO adapter passes it through to Socket.IO (express-cors (origin, callback)).

idleTimeout?

optional idleTimeout?: number

Defined in: src/core/networking/websocket-adapter.ts:31

maxPayloadLength?

optional maxPayloadLength?: number

Defined in: src/core/networking/websocket-adapter.ts:30

path?

optional path?: string

Defined in: src/core/networking/websocket-adapter.ts:29

verifyClient?

optional verifyClient?: (info) => boolean

Defined in: src/core/networking/websocket-adapter.ts:36

Optional upgrade-time authentication hook (ws adapter). Return false to reject the handshake. Runs after the CORS origin check passes.

Parameters

info

origin?

string

req

any

secure

boolean

Returns

boolean