Type Alias BaseCreateHostContextParams

The portion of CreateHostContextBase's parameters that's independent of the runtime environment. Both host (server) createHostContext and client (mock-host) createHostContext callbacks receive these fields; each side layers its own extras on top.

Package

@rest-vir/api

type BaseCreateHostContextParams = {
    endpointDefinition: Readonly<EndpointDefinition> | undefined;
    method: DefinableHttpMethod;
    requestData: unknown;
    requestHeaders: Readonly<Record<string, string | string[] | undefined>>;
    searchParams: BaseSearchParams;
    webSocketDefinition: Readonly<WebSocketDefinition> | undefined;
}

Index

Properties

endpointDefinition method requestData requestHeaders searchParams webSocketDefinition

Properties

endpointDefinition

endpointDefinition: Readonly<EndpointDefinition> | undefined

method

method: DefinableHttpMethod

requestData

requestData: unknown

requestHeaders

requestHeaders: Readonly<Record<string, string | string[] | undefined>>

searchParams

searchParams: BaseSearchParams

webSocketDefinition

webSocketDefinition: Readonly<WebSocketDefinition> | undefined