Function fetchApi

Fetches the data from the given endpoint and returns it.

Param: endpoint

The endpoint to fetch from.

Param: params

The parameters to pass to the endpoint.

Param: requestOptions

Any additional options to pass to fetch.

Returns

The response from the endpoint.

  • fetchApi<S, R>(endpoint, params, requestOptions?): Promise<R extends false
        ? ExtractResponse<S>
        : TypedJsonResponse<ExtractResponse<S>>>

  • Fetches the data from the given endpoint and returns it.

    Type Parameters

    Parameters

    • endpoint: S

      The endpoint to fetch from.

    • params: ExtractParams<S>

      The parameters to pass to the endpoint.

    • OptionalrequestOptions: RequestOptions<R>

      Any additional options to pass to fetch.

    Returns Promise<R extends false
        ? ExtractResponse<S>
        : TypedJsonResponse<ExtractResponse<S>>>

    The response from the endpoint.

  • fetchApi<S, R>(endpoint, params?, requestOptions?): Promise<R extends false
        ? ExtractResponse<S>
        : TypedJsonResponse<ExtractResponse<S>>>

  • Fetches the data from the given endpoint and returns it.

    Type Parameters

    Parameters

    • endpoint: S & {
          parameters?: undefined;
      }

      The endpoint to fetch from.

    • Optionalparams: ExtractParams<S>

      Optional parameters to pass to the endpoint.

    • OptionalrequestOptions: RequestOptions<R>

      Any additional options to pass to fetch.

    Returns Promise<R extends false
        ? ExtractResponse<S>
        : TypedJsonResponse<ExtractResponse<S>>>

    The response from the endpoint.

Settings

Member Visibility