Skip to content

postgrestx-monorepo v0.0.1


postgrestx-monorepo / tanstack/src / useDelete

Function: useDelete()

useDelete<PK>(tableName, options?): UseMutationResult<void, unknown, { pk: PK; pkColumn?: string; }, unknown>

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

Delete a single row by primary key.

Type Parameters

PK

PK extends PrimaryKey = PrimaryKey

Parameters

tableName

string

options?

UseMutationOptions<void, unknown, { pk: PK; pkColumn?: string; }, unknown>

Returns

UseMutationResult<void, unknown, { pk: PK; pkColumn?: string; }, unknown>

Example

ts
const del = useDelete('users')
del.mutate({ pk: 3 })