PostgRESTX

Appearance

postgrestx-monorepo v0.0.1

postgrestx-monorepo / tanstack/src / useInsert

Function: useInsert() ​

useInsert<Inserted, InsertInput>(tableName, options?): UseMutationResult<Inserted, unknown, InsertInput, unknown>

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

Insert row(s) into a table as a mutation hook.

Type Parameters ​

Inserted ​

Inserted = unknown

InsertInput ​

InsertInput = unknown

Parameters ​

tableName ​

string

options? ​

UseMutationOptions<Inserted, unknown, InsertInput, unknown>

Returns ​

UseMutationResult<Inserted, unknown, InsertInput, unknown>

Example ​

ts
const insertUser = useInsert<User, NewUser>('users', { onSuccess: () => invalidateTable(qc, 'users') })
insertUser.mutate({ name: 'Ada' })