postgrestx-monorepo v0.0.1

---

postgrestx-monorepo / tanstack/src / useUpdate

Function: useUpdate()

useUpdate<Updated, PK, Table>(tableName, options?): UseMutationResult<Updated, unknown, { pk: PK; patch: Partial<Table>; pkColumn?: string; }, unknown>

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

Update rows by primary key (single row convenience) using a patch object.

Type Parameters

Updated

Updated = unknown

PK

PK extends PrimaryKey = PrimaryKey

Table

Table = unknown

Parameters

tableName

string

options?

UseMutationOptions<Updated, unknown, { pk: PK; patch: Partial<Table>; pkColumn?: string; }, unknown>

Returns

UseMutationResult<Updated, unknown, { pk: PK; patch: Partial<Table>; pkColumn?: string; }, unknown>

Example

const updateUser = useUpdate<User>('users')
updateUser.mutate({ pk: 1, patch: { name: 'Grace' } })