rest-vir - v1.0.0
    Preparing search index...

    Type Alias ContextInitParams<ServiceName, EndpointsInit, WebSocketsInit>

    Parameters for ContextInit.

    type ContextInitParams<
        ServiceName extends string = any,
        EndpointsInit extends BaseServiceEndpointsInit | NoParam = NoParam,
        WebSocketsInit extends BaseServiceWebSocketsInit | NoParam = NoParam,
    > = {
        endpointDefinition?: EndpointsInit extends NoParam
            ? EndpointDefinition
            : WithFinalEndpointProps<
                Values<EndpointsInit>,
                Extract<keyof EndpointsInit, EndpointPathBase>,
            >;
        method: HttpMethod;
        pathParams: EndpointsInit extends NoParam
            ? Readonly<Record<string, string>>
            : PathParams<WithFinalWebSocketProps<Values<WebSocketsInit>, any>["path"]> extends string
                ? Readonly<
                    Record<
                        PathParams<
                            WithFinalWebSocketProps<Values<WebSocketsInit>, any>["path"],
                        >,
                        string,
                    >,
                >
                : Readonly<Record<string, string>>;
        request: ServerRequest;
        requestData: EndpointsInit extends NoParam
            ? unknown
            : WithFinalEndpointProps<
                Values<EndpointsInit>,
                Extract<keyof EndpointsInit, EndpointPathBase>,
            >["RequestType"];
        requestHeaders: IncomingHttpHeaders;
        response: ServerResponse;
        searchParams: ReplaceUndefinedWithEmptyObject<
            | (
                WebSocketsInit extends NoParam
                    ? BaseSearchParams
                    | undefined
                    : WithFinalWebSocketProps<Values<WebSocketsInit>, any>["SearchParamsType"]
            )
            | (
                EndpointsInit extends NoParam
                    ? BaseSearchParams
                    | undefined
                    : WithFinalEndpointProps<Values<EndpointsInit>, any>["SearchParamsType"]
            ),
        >;
        server: RunningServerInfo;
        service: MinimalService<ServiceName>;
        webSocketDefinition?: WebSocketsInit extends NoParam
            ? WebSocketDefinition
            : WithFinalWebSocketProps<
                Values<WebSocketsInit>,
                Extract<keyof WebSocketsInit, EndpointPathBase>,
            >;
    }

    Type Parameters

    Index

    Properties

    endpointDefinition?: EndpointsInit extends NoParam
        ? EndpointDefinition
        : WithFinalEndpointProps<
            Values<EndpointsInit>,
            Extract<keyof EndpointsInit, EndpointPathBase>,
        >
    method: HttpMethod
    pathParams: EndpointsInit extends NoParam
        ? Readonly<Record<string, string>>
        : PathParams<WithFinalWebSocketProps<Values<WebSocketsInit>, any>["path"]> extends string
            ? Readonly<
                Record<
                    PathParams<
                        WithFinalWebSocketProps<Values<WebSocketsInit>, any>["path"],
                    >,
                    string,
                >,
            >
            : Readonly<Record<string, string>>
    request: ServerRequest
    requestData: EndpointsInit extends NoParam
        ? unknown
        : WithFinalEndpointProps<
            Values<EndpointsInit>,
            Extract<keyof EndpointsInit, EndpointPathBase>,
        >["RequestType"]
    requestHeaders: IncomingHttpHeaders
    response: ServerResponse
    searchParams: ReplaceUndefinedWithEmptyObject<
        | (
            WebSocketsInit extends NoParam
                ? BaseSearchParams
                | undefined
                : WithFinalWebSocketProps<Values<WebSocketsInit>, any>["SearchParamsType"]
        )
        | (
            EndpointsInit extends NoParam
                ? BaseSearchParams
                | undefined
                : WithFinalEndpointProps<Values<EndpointsInit>, any>["SearchParamsType"]
        ),
    >

    The actual running server info.

    webSocketDefinition?: WebSocketsInit extends NoParam
        ? WebSocketDefinition
        : WithFinalWebSocketProps<
            Values<WebSocketsInit>,
            Extract<keyof WebSocketsInit, EndpointPathBase>,
        >