Interface EscapeOptions

Options accepted by AbstractQueryGeneratorTypeScript#escape

interface EscapeOptions {
    bindParam?: (value: unknown) => string;
    mainAlias?: string;
    model?: null | ModelDefinition<Model<any, any>> | ModelStatic;
    parameterStyle?: "BIND" | "REPLACEMENT" | ParameterStyle;
    replacements?: BindOrReplacements;
    type?: DataType;
}

Hierarchy (View Summary)

Properties

bindParam? mainAlias? model? parameterStyle? replacements? type?

Properties

OptionalbindParam

bindParam?: (value: unknown) => string

Optional ReadonlymainAlias

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 Readonlymodel

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 ReadonlyparameterStyle

parameterStyle?: "BIND" | "REPLACEMENT" | ParameterStyle

The style of parameter to use.

Optional Readonlyreplacements

replacements?: BindOrReplacements

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

Optional Readonlytype

type?: DataType

Settings

Member Visibility

On This Page

Properties