Type Alias VariantInsertPayload<TEntity, K>

VariantInsertPayload: VariantResult<TEntity, K> extends infer B extends
    Record<string, unknown>
    ? Omit<
        { [P in keyof B]?: B[P] },
        { [P in keyof B]-?: B[P] extends K ? K extends B[P] ? P : never : never }[keyof B],
    >
    : never

Write payload for DbSet.insertVariant(key, payload).

All columns from the matching variant branch are optional (so auto-generated PKs and columns with DB defaults can be omitted), and the discriminator field is excluded (it is set automatically from key).

Type Parameters

TEntity extends Entity<any, any, any>
K extends string

Example

// Only valid fields for the 'assigned' variant; type-checked at compile time:
await db.activities.insertVariant('assigned', {
    todoId: 42,
    userId: 7,
    assigneeId: 9,
});

Type Alias VariantInsertPayload<TEntity, K>

Type Parameters

Example

Settings