katanakit-js / usePost

Function: usePost()

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

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

POST 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.
body?	unknown	Optional request body (auto-serialized to JSON unless raw).
urlOptions?	UrlOptions	Optional URL building options.

Returns

Promise<FetchResult<T>>

A FetchResult with data or error.

Example

import { usePost } from "katanakit-js";

const result = await usePost("pokeapi", "createPokemon", { name: "Pikachu" });