Interface FormatWhereOptions

Methods that support this option are functions that add values to the query. If Bindable.bindParam is specified, the value will be added to the query as a bind parameter. If it is not specified, the value will be added to the query as a literal.

interface FormatWhereOptions {
    bindParam?: ((value) => string);
    mainAlias?: string;
    model?: null | ModelDefinition<Model<any, any>> | ModelStatic;
    replacements?: BindOrReplacements;
}

Hierarchy (view full)

Properties

bindParam? mainAlias? model? replacements?

Properties

Optional bindParam

bindParam?: ((value) => string)

Type declaration

    • (value): string

    • Parameters

      • value: unknown

      Returns string

Optional Readonly mainAlias

mainAlias?: string

The alias of the main table corresponding to FormatWhereOptions.model. Used as the prefix for attributes that do not reference an association, e.g.

const where = { name: 'foo' };

will produce

WHERE "<mainAlias>"."name" = 'foo'

Optional Readonly model

model?: null | ModelDefinition<Model<any, any>> | ModelStatic

The model of the main alias. Used to determine the type & column name of attributes referenced in the where clause.

Optional Readonly replacements

replacements?: BindOrReplacements

These are used to inline replacements into the query, when one is found inside of a Literal.

Settings

Member Visibility

Theme

On This Page

bindParammainAliasmodelreplacements