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

    Type Alias FetchEndpointParams<EndpointToFetch, AllowFetchMock>

    FetchEndpointParams: EndpointToFetch extends EndpointDefinition
        ? Readonly<
            (
                IsNever<PathParams<EndpointToFetch["path"]>> extends true
                    ? { pathParams?: undefined }
                    : PathParams<EndpointToFetch["path"]> extends string
                        ? { pathParams: Readonly<Record<PathParams<(...)[(...)]>, string>> }
                        : { pathParams?: undefined }
            ) & (
                EndpointToFetch["SearchParamsType"] extends undefined
                    ? { searchParams?: never }
                    : { searchParams: EndpointToFetch["SearchParamsType"] }
            ) & (
                EndpointExecutorData<EndpointToFetch>["request"] extends undefined
                    ? { requestData?: never }
                    : { requestData: EndpointExecutorData<EndpointToFetch>["request"] }
            ) & (
                IsNever<FetchMethod<EndpointToFetch>> extends true
                    ? { method?: never }
                    : { method: FetchMethod<EndpointToFetch> }
            ) & (
                AllowFetchMock extends true
                    ? Pick<
                        GenericFetchEndpointParams,
                        "options"
                        | "fetch"
                        | "bypassResponseValidation",
                    >
                    : Pick<
                        GenericFetchEndpointParams,
                        "options"
                        | "bypassResponseValidation",
                    >
            ),
        >
        : GenericFetchEndpointParams

    All type safe parameters for sending a request to an endpoint using fetchEndpoint.

    Type Parameters

    • EndpointToFetch extends SelectFrom<
          EndpointDefinition,
          {
              methods: true;
              path: true;
              requestDataShape: true;
              responseDataShape: true;
          },
      >
    • AllowFetchMock extends boolean = true