postgrestx-monorepo v0.0.1

---

postgrestx-monorepo / tanstack/src / useRpc

Function: useRpc()

useRpc<RpcReturn, RpcArgs>(functionName, options?): UseMutationResult<RpcReturn, unknown, RpcArgs, unknown>

Defined in: packages/tanstack/src/index.ts:412

Execute a PostgREST RPC function as a mutation.

Type Parameters

RpcReturn

RpcReturn = unknown

RpcArgs

RpcArgs extends Record<string, unknown> = Record<string, unknown>

Parameters

functionName

string

options?

UseMutationOptions<RpcReturn, unknown, RpcArgs, unknown>

Returns

UseMutationResult<RpcReturn, unknown, RpcArgs, unknown>

Example

const runSearch = useRpc<{ id: number }[], { term: string }>('search_users')
runSearch.mutate({ term: 'ada' })