Function fetchApi`Param` `Returns`

Fetches the data from the given endpoint and returns it.

endpoint The endpoint to fetch from. params The parameters to pass to the endpoint. requestOptions Any additional options to pass to fetch. The response from the endpoint.

fetchApi<S extends EndpointSchema>(
    endpoint: S,
    params: ExtractParams<S>,
    requestOptions: Omit<RequestOptions<true>, "returnRaw"> & {
        returnRaw: true;
    },
): Promise<TypedJsonResponse<ExtractResponse<S>>>
Param Returns
Fetches the data from the given endpoint and returns it.

endpoint The endpoint to fetch from. params The parameters to pass to the endpoint. requestOptions Any additional options to pass to fetch. The response from the endpoint.
Type Parameters
- S extends EndpointSchema
Parameters
- endpoint: S
- params: ExtractParams<S>
- requestOptions: Omit<RequestOptions<true>, "returnRaw"> & { returnRaw: true }
Returns Promise<TypedJsonResponse<ExtractResponse<S>>>
- Defined in src/index.ts:348
fetchApi<S extends EndpointSchema>(
    endpoint: S & { parameters?: undefined },
    params: undefined | ExtractParams<S>,
    requestOptions: Omit<RequestOptions<true>, "returnRaw"> & {
        returnRaw: true;
    },
): Promise<TypedJsonResponse<ExtractResponse<S>>>
Param Returns
Fetches the data from the given endpoint and returns it.

endpoint The endpoint to fetch from. params The parameters to pass to the endpoint. requestOptions Any additional options to pass to fetch. The response from the endpoint.
Type Parameters
- S extends EndpointSchema
Parameters
- endpoint: S & { parameters?: undefined }
- params: undefined | ExtractParams<S>
- requestOptions: Omit<RequestOptions<true>, "returnRaw"> & { returnRaw: true }
Returns Promise<TypedJsonResponse<ExtractResponse<S>>>
- Defined in src/index.ts:353
fetchApi<S extends EndpointSchema>(
    endpoint: S,
    params: ExtractParams<S>,
    requestOptions: Omit<RequestOptions<false>, "returnRaw" | "throwOnError"> & {
        returnRaw?: false;
        throwOnError: true;
    },
): Promise<ExtractResponse<S>>
Param Returns
Fetches the data from the given endpoint and returns it.

endpoint The endpoint to fetch from. params The parameters to pass to the endpoint. requestOptions Any additional options to pass to fetch. The response from the endpoint.
Type Parameters
- S extends EndpointSchema
Parameters
- endpoint: S
- params: ExtractParams<S>
- requestOptions: Omit<RequestOptions<false>, "returnRaw" | "throwOnError"> & {
  returnRaw?: false;
  throwOnError: true;
  }
Returns Promise<ExtractResponse<S>>
- Defined in src/index.ts:360
fetchApi<S extends EndpointSchema>(
    endpoint: S & { parameters?: undefined },
    params: undefined | ExtractParams<S>,
    requestOptions: Omit<RequestOptions<false>, "returnRaw" | "throwOnError"> & {
        returnRaw?: false;
        throwOnError: true;
    },
): Promise<ExtractResponse<S>>
Param Returns
Fetches the data from the given endpoint and returns it.

endpoint The endpoint to fetch from. params The parameters to pass to the endpoint. requestOptions Any additional options to pass to fetch. The response from the endpoint.
Type Parameters
- S extends EndpointSchema
Parameters
- endpoint: S & { parameters?: undefined }
- params: undefined | ExtractParams<S>
- requestOptions: Omit<RequestOptions<false>, "returnRaw" | "throwOnError"> & {
  returnRaw?: false;
  throwOnError: true;
  }
Returns Promise<ExtractResponse<S>>
- Defined in src/index.ts:365
fetchApi<S extends EndpointSchema>(
    endpoint: S,
    params: ExtractParams<S>,
    requestOptions?: Omit<RequestOptions<false>, "returnRaw"> & {
        returnRaw?: false;
    },
): Promise<AnyError | ExtractResponse<S>>
Param Returns
Fetches the data from the given endpoint and returns it.

endpoint The endpoint to fetch from. params The parameters to pass to the endpoint. requestOptions Any additional options to pass to fetch. The response from the endpoint.
Type Parameters
- S extends EndpointSchema
Parameters
- endpoint: S
- params: ExtractParams<S>
- OptionalrequestOptions: Omit<RequestOptions<false>, "returnRaw"> & { returnRaw?: false }
Returns Promise<AnyError | ExtractResponse<S>>
- Defined in src/index.ts:372
fetchApi<S extends EndpointSchema>(
    endpoint: S & { parameters?: undefined },
    params?: ExtractParams<S>,
    requestOptions?: Omit<RequestOptions<false>, "returnRaw"> & {
        returnRaw?: false;
    },
): Promise<AnyError | ExtractResponse<S>>
Param Returns
Fetches the data from the given endpoint and returns it.

endpoint The endpoint to fetch from. params The parameters to pass to the endpoint. requestOptions Any additional options to pass to fetch. The response from the endpoint.
Type Parameters
- S extends EndpointSchema
Parameters
- endpoint: S & { parameters?: undefined }
- Optionalparams: ExtractParams<S>
- OptionalrequestOptions: Omit<RequestOptions<false>, "returnRaw"> & { returnRaw?: false }
Returns Promise<AnyError | ExtractResponse<S>>
- Defined in src/index.ts:377
fetchApi<S extends EndpointSchema, R extends boolean = false>(
    endpoint: S,
    params: undefined | ExtractParams<S>,
    requestOptions?: RequestOptions<R>,
): Promise<
    R extends true
        ? TypedJsonResponse<ExtractResponse<S>>
        : AnyError | ExtractResponse<S>,
>
Param Returns
Fetches the data from the given endpoint and returns it.

endpoint The endpoint to fetch from. params Optional parameters to pass to the endpoint. requestOptions Any additional options to pass to fetch. The response from the endpoint.
Type Parameters
- S extends EndpointSchema
- R extends boolean = false
Parameters
- endpoint: S
- params: undefined | ExtractParams<S>
- OptionalrequestOptions: RequestOptions<R>
Returns Promise<
    R extends true
        ? TypedJsonResponse<ExtractResponse<S>>
        : AnyError | ExtractResponse<S>,
>
- Defined in src/index.ts:392

Function fetchApiParam Returns

Type Parameters

Parameters

Returns Promise<TypedJsonResponse<ExtractResponse<S>>>

Type Parameters

Parameters

Returns Promise<TypedJsonResponse<ExtractResponse<S>>>

Type Parameters

Parameters

Returns Promise<ExtractResponse<S>>

Type Parameters

Parameters

Returns Promise<ExtractResponse<S>>

Type Parameters

Parameters

Returns Promise<AnyError | ExtractResponse<S>>

Type Parameters

Parameters

Returns Promise<AnyError | ExtractResponse<S>>

Type Parameters

Parameters

Returns Promise< R extends true ? TypedJsonResponse<ExtractResponse<S>> : AnyError | ExtractResponse<S>,>

Settings

Function fetchApi`Param` `Returns`

Returns Promise<
R extends true
? TypedJsonResponse<ExtractResponse<S>>
: AnyError | ExtractResponse<S>,
>