Documentation

Documentation / @zerotal/orm / index / UpdatePayload

Type Alias: UpdatePayload<T>

UpdatePayload<T> = Partial<InsertPayload<T>>

Defined in: packages/orm/src/model/payload.ts:106

Data shape accepted when updating an existing record. Every field is optional — pass only what should change.

Type Parameters

T

T

Example

const user = await User.findOrFail(ctx.integer("id"));
await user.update(await ctx.body<UpdatePayload<User>>());

// Alias pattern:
export type UserPatch = UpdatePayload<User>;