Skip to content

UseGetApi

katanakit-js / useGetApi

function useGetApi<T>(
apiName,
endpointName,
urlOptions?
): Promise<FetchResult<T>>;

Defined in: core/services/http.service.ts:703

GET helper over a registered API endpoint. Alias for useGet.

Type Parameter Default type
T unknown
Parameter Type Description
apiName string The registered API key.
endpointName string The endpoint key within the API.
urlOptions? UrlOptions Optional URL building options.

Promise<FetchResult<T>>

A FetchResult with data or error.