katanakit-js / useGet

Function: useGet()

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

Defined in: src/core/services/http.service.ts:744

GET helper over a registered API endpoint.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

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

Returns

Promise<FetchResult<T>>

A FetchResult with data or error.

Example

import { useGet } from "katanakit-js";

const result = await useGet("pokeapi", "pokemonById", { params: { id: 25 } });