Type Alias EndpointFetchParamObject<Endpoint, Method>

EndpointFetchParamObject: SetNullishPropertiesAsOptional<
    {
        fetchOverride: ClientFetch
        | undefined;
        options: Omit<RequestInit, "body" | "method"> | undefined;
        pathParams: ExtractPathParams<
            Endpoint extends { path: string } ? Endpoint["path"] : NoParam,
        >;
        requestData: EndpointRequestType<Endpoint, Method>;
        requiredHeaders: EndpointRequestHeadersType<
            ExtractEndpointMethodDefinitionWithNoParam<Endpoint, Method>,
        >;
        searchParams: RouteSearchParamsType<
            ExtractEndpointMethodDefinition<Endpoint, Method>,
        >;
        skipAutomaticContentTypeHeader: boolean | undefined;
    },
>

An client params object for calling an endpoint. Only the params that have required options to set are required, the rest are optional. Pass NoParam for a completely generic param object that all param objects should be assignable to, with all properties being optional.

Type Parameters

Endpoint extends EndpointDefinition | NoParam = NoParam
Method extends DefinableHttpMethod | NoParam = NoParam

Package

@rest-vir/api

Type Alias EndpointFetchParamObject<Endpoint, Method>

Type Parameters

Package

Settings