Class WebsocketRequest<T, PathParamsObject, QueryParamsObject, HeaderParamsObject>

A websocket request sent from a client.

Type Parameters

T = unknown
PathParamsObject extends Record<string, unknown> = Record<string, string | undefined>
QueryParamsObject extends Record<string, unknown> = Record<string, string | undefined>
HeaderParamsObject extends Record<string, unknown> = Partial<Record<Header, string | undefined>>

Implements

Partial<
    Pick<
        HttpRequest<T, PathParamsObject, QueryParamsObject, HeaderParamsObject>,
        "headers" | "body" | "query" | "params",
    >,
>

Index

Constructors

Properties

body headers params query

Constructors

constructor

new WebsocketRequest<
    T = unknown,
    PathParamsObject extends
        Record<string, unknown> = Record<string, string | undefined>,
    QueryParamsObject extends
        Record<string, unknown> = Record<string, string | undefined>,
    HeaderParamsObject extends
        Record<string, unknown> = Partial<Record<Header, string | undefined>>,
>(): WebsocketRequest<
    T,
    PathParamsObject,
    QueryParamsObject,
    HeaderParamsObject,
>
Type Parameters
- T = unknown
- PathParamsObject extends Record<string, unknown> = Record<string, string | undefined>
- QueryParamsObject extends Record<string, unknown> = Record<string, string | undefined>
- HeaderParamsObject extends Record<string, unknown> = Partial<Record<Header, string | undefined>>
Returns WebsocketRequest<T, PathParamsObject, QueryParamsObject, HeaderParamsObject>

Properties

body

body: T | undefined

headers

headers: HeaderParamsObject | undefined

The header parameters of the request, as an object.

params

params: PathParamsObject | undefined

The path parameters of the request, as an object.

query

query: QueryParamsObject | undefined

The query parameters of the request, as an object.