Function: WebSocket()

WebSocket(path?, options?): (target, propertyKey, descriptor) => void

Defined in: service-core/src/decorators/RouteDecorators.ts:587

Indicates that the decorated function handles incoming WebSocket upgrade requests at the given sub-path.

Parameters

path?

string

The sub-path that the route will handle requests for.

options?

WebSocketRouteOptions

Optional WebSocket limits for this route (message size, send backpressure, idle timeout). See WebSocketRouteOptions. Omit it to keep the defaults.

Returns

(target, propertyKey, descriptor) => void