katanakit-js / useBuildUrl

Function: useBuildUrl()

function useBuildUrl(
   apiName, 
   endpointName, 
   options?
): string;

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

Returns the URL of a registered endpoint without calling fetch.

Parameters

Parameter	Type	Description
apiName	string	Registered API key (from defineApiConfig).
endpointName	string	Endpoint key inside that API.
options	UrlOptions	params fills :placeholders, query becomes the search string.

Returns

string

The fully built URL.

Throws

Unknown API, unknown endpoint, or a scheme that is not http(s).

Example

import { useBuildUrl } from "katanakit-js";

useBuildUrl("pokeapi", "pokemonById", { params: { id: 25 } });
// → "https://pokeapi.co/api/v2/pokemon/25"