Interface InsertTransforms<DB, TB, InsertedObject, InsertReturnColumns, InsertReturn>

Type Parameters

  • DB

  • TB extends keyof DB & string

  • InsertedObject

  • InsertReturnColumns extends Readonly<SelectionColumn<DB, TB>[]> | ["*"]

  • InsertReturn

Hierarchy

Properties

insertReturnTransform? insertTransform?

Properties

Optional insertReturnTransform

insertReturnTransform?: ((source, returns) => InsertReturn)

Type declaration

    • (source, returns): InsertReturn

    • Transformation to apply to column values returned from inserts before returning values to the client. When inferring type parameters, specify a type for the source parameter. source is the object that was provided for insertion, and returns are the values returned from the insert.

      Parameters

      • source: InsertedObject
      • returns: InsertReturnColumns extends []
            ? never
            : SelectedRow<DB, TB, InsertReturnColumns extends ["*"]
                ? never
                : InsertReturnColumns[number], InsertReturnColumns>

      Returns InsertReturn

Optional insertTransform

insertTransform?: ((source, columns) => Insertable<DB[TB]>)

Type declaration

    • (source, columns): Insertable<DB[TB]>

    • Transformation to apply to inserted objects before insertion. source is the object provided for insertion. Only the columns in columns will actually be inserted, with [*] indicating all columns.

      Parameters

      • source: InsertedObject
      • columns: ["*"] | readonly (NonNullableInsertKeys<DB[TB]> | NullableInsertKeys<DB[TB]>)[]

      Returns Insertable<DB[TB]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc