Utils | @sequelize/core

Type aliases

AllowArray

AllowArray<T>: T | T[]

Type parameters

AllowReadonlyArray

AllowReadonlyArray<T>: T | readonly T[]

Type parameters

AnyFunction

AnyFunction: (...args: any[]) => any

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

DeepWriteable

DeepWriteable<T>: { -readonly [ P in keyof T]: DeepWriteable<T[P]> }

Type parameters

FinderOptions

FinderOptions<TAttributes>: { attributes?: string[]; where?: WhereOptions<TAttributes> }

Type parameters

TAttributes

Type declaration

Optional attributes?: string[]
Optional where?: WhereOptions<TAttributes>

MakeNullishOptional

MakeNullishOptional<T>: Optional<T, NullishPropertiesOf<T>>

Makes all shallow properties of an object optional if they accept undefined or null as a value.

example

type MyOptionalType = MakeUndefinedOptional<{
  id: number | undefined,
  firstName: string,
  lastName: string | null,
}>;

// is equal to

type MyOptionalType = {
  // this property is optional.
  id?: number | undefined,
  firstName: string,
  // this property is optional.
  lastName?: string | null,
};

Type parameters

T: object

MappedFinderOptions

MappedFinderOptions<TAttributes>: Omit<FinderOptions<TAttributes>, "attributes"> & { attributes?: ([columnName: string, attributeName: string] | string)[] }

Type parameters

TAttributes

Nullish

Nullish<T>: T | null | undefined

Makes the type accept null & undefined

Type parameters

NullishPropertiesOf

NullishPropertiesOf<T>: { [ P in keyof T]-?: undefined extends T[P] ? P : null extends T[P] ? P : never }[keyof T]

Returns all shallow properties that accept undefined or null. Does not include Optional properties, only undefined or null.

example

type UndefinedProps = NullishPropertiesOf<{
  id: number | undefined,
  createdAt: string | undefined,
  firstName: string | null, // nullable properties are included
  lastName?: string, // optional properties are not included.
}>;

// is equal to

type UndefinedProps = 'id' | 'createdAt' | 'firstName';

Type parameters

PartlyRequired

PartlyRequired<T, K>: Omit<T, K> & Required<Pick<T, K>>

Type parameters

T
K: keyof T

Variables

Const TICK_CHAR

TICK_CHAR: "`" = "`"

Functions

addTicks

addTicks(s: string, tickChar?: string): string

- Defined in types/utils/dialect.d.ts:4
Parameters
- s: string
- Optional tickChar: string
Returns string

camelize

camelize(str: string): string

- Defined in types/utils/string.d.ts:5
Parameters
- str: string
Returns string

camelizeIf

camelizeIf(str: string, condition: boolean): string

- Defined in types/utils/string.d.ts:4
Parameters
- str: string
- condition: boolean
Returns string

Private camelizeObjectKeys

camelizeObjectKeys(obj: {}): {}

- Defined in types/utils/object.d.ts:84
Parameters
- obj: {}
  - [key: string]: any
Returns {}
A new object with camel-cased keys
- [key: string]: any

canTreatArrayAsAnd

canTreatArrayAsAnd(arr: unknown[]): arr is (object | Where<typeof eq>)[]

- Defined in types/utils/check.d.ts:17
Parameters
- arr: unknown[]
Returns arr is (object | Where<typeof eq>)[]

Private classToInvokable

classToInvokable<Class>(constructor: Class): Callable<Class>

- Defined in types/utils/class-to-invokable.d.ts:10
Wraps a constructor to not need the new keyword using a proxy. Only used for data types.

Type parameters
- Class: new (...args: any[]) => any
Parameters
- constructor: Class
  
  The class instance to wrap as invocable.
Returns Callable<Class>
Wrapped class instance.

cloneDeep

cloneDeep<T>(obj: T, onlyPlain?: boolean): T

- Defined in types/utils/object.d.ts:22
Type parameters
- T: object
Parameters
- obj: T
- Optional onlyPlain: boolean
Returns T

combineTableNames

combineTableNames(tableName1: string, tableName2: string): string

- Defined in types/utils/format.d.ts:43
Parameters
- tableName1: string
- tableName2: string
Returns string

Private defaultValueSchemable

defaultValueSchemable(value: DataTypes.DataType): boolean

- Defined in types/utils/check.d.ts:25
Determine if the default value provided exists and can be described in a db schema using the DEFAULT directive.

Parameters
- value: DataTypes.DataType
  
  Any default value.
Returns boolean

Private defaults

defaults(objectIn: {}, ...sources: {}[]): object

- Defined in types/utils/object.d.ts:73
Assigns own and inherited enumerable string and symbol keyed properties of source objects to the destination object.

https://lodash.com/docs/4.17.4#defaults

Note: This method mutates object.

Parameters
- objectIn: {}
  
  The destination object.
  - [key: string]: any
- Rest ...sources: {}[]
  
  The source objects.
Returns object
Returns object.

Private flattenObjectDeep

flattenObjectDeep<T>(value: T): T extends object ? Flatten<T> : T

- Defined in types/utils/object.d.ts:52
Receives a tree-like object and returns a plain object which depth is 1.
- Input:
{ name: 'John', address: { street: 'Fake St. 123', coordinates: { longitude: 55.6779627, latitude: 12.5964313 } } }
- Output:
{ name: 'John', address.street: 'Fake St. 123', address.coordinates.latitude: 55.6779627, address.coordinates.longitude: 12.5964313 }
Type parameters
- T
Parameters
- value: T
  
  an Object
Returns T extends object ? Flatten<T> : T
a flattened object

Private generateEnumName

generateEnumName(tableName: string, columnName: string): string

- Defined in types/utils/format.d.ts:73
Returns ENUM name by joining table and column name

Parameters
- tableName: string
- columnName: string
Returns string

Private getComplexKeys

getComplexKeys(obj: object): (string | symbol)[]

- Defined in types/utils/format.d.ts:34
getComplexKeys

Parameters
- obj: object
Returns (string | symbol)[]
All keys including operators

Private getComplexSize

getComplexSize(obj: object | any[]): number

- Defined in types/utils/index.d.ts:18
getComplexSize

Parameters
- obj: object | any[]
Returns number
Length of object properties including operators if obj is array returns its length

Private getOperators

getOperators(obj: object): symbol[]

- Defined in types/utils/format.d.ts:42
getOperators

Parameters
- obj: object
Returns symbol[]
All operators properties of obj

Private intersects

intersects<T>(arr1: T[], arr2: T[]): boolean

- Defined in types/utils/array.d.ts:8
Checks if 2 arrays intersect.

Type parameters
- T
Parameters
- arr1: T[]
- arr2: T[]
Returns boolean

isColString

isColString(value: string): boolean

- Defined in types/utils/check.d.ts:16
Returns whether value is using the nested syntax for attributes.
example
```
isColString('$id$'); // true
isColString('$project.name$'); // true
isColString('name'); // false
```
Parameters
- value: string
  
  The attribute reference to check.
Returns boolean

isPrimitive

isPrimitive(val: any): val is string | number | boolean

- Defined in types/utils/check.d.ts:3
Parameters
- val: any
Returns val is string | number | boolean

isWhereEmpty

isWhereEmpty(obj: object): boolean

- Defined in types/utils/check.d.ts:31
Returns true if a where clause is empty, even with Symbols

Parameters
- obj: object
Returns boolean

Private joinSQLFragments

joinSQLFragments(array: SQLFragment[]): string

- Defined in types/utils/join-sql-fragments.d.ts:15
Joins an array with a single space, auto trimming when needed.

Certain elements do not get leading/trailing spaces.

Parameters
- array: SQLFragment[]
  
  The array to be joined. Falsy values are skipped. If an element is another array, this function will be called recursively on that array. Otherwise, if a non-string, non-falsy value is present, a TypeError will be thrown.
Returns string
The joined string.

mapFinderOptions

mapFinderOptions<M, T>(options: T, Model: ModelStatic<Model<any, any>>): MappedFinderOptions<Attributes<M>>

- Defined in types/utils/format.d.ts:16
Expand and normalize finder options. Mutates the "options" parameter.

Type parameters
- M: Model<any, any, M>
- T: FinderOptions<Attributes<M>>
Parameters
- options: T
- Model: ModelStatic<Model<any, any>>
Returns MappedFinderOptions<Attributes<M>>

mapOptionFieldNames

mapOptionFieldNames<M>(options: FinderOptions<Attributes<M>>, Model: ModelStatic<Model<any, any>>): MappedFinderOptions<Attributes<M>>

- Defined in types/utils/format.d.ts:25
Used to map field names in attributes and where conditions.

Mutates the "options" parameter.

Type parameters
- M: Model<any, any, M>
Parameters
- options: FinderOptions<Attributes<M>>
- Model: ModelStatic<Model<any, any>>
Returns MappedFinderOptions<Attributes<M>>

mapValueFieldNames

mapValueFieldNames(dataValues: Record<string, any>, attributeNames: string[], ModelClass: ModelStatic<Model<any, any>>): Record<string, any>

- Defined in types/utils/format.d.ts:51
Used to map field names in values

Parameters
- dataValues: Record<string, any>
- attributeNames: string[]
- ModelClass: ModelStatic<Model<any, any>>
Returns Record<string, any>

mapWhereFieldNames

mapWhereFieldNames(where: Record<string | symbol, any>, Model: ModelStatic<Model<any, any>>): object

- Defined in types/utils/format.d.ts:26
Parameters
- where: Record<string | symbol, any>
- Model: ModelStatic<Model<any, any>>
Returns object

merge

merge(...args: object[]): object

- Defined in types/utils/object.d.ts:21
An alternative to _.merge, which doesn't clone its arguments.

Does not mutate parameters.

Cloning is a bad idea because options arguments may contain references to sequelize models - which again reference database libs which don't like to be cloned (in particular pg-native)

Parameters
- Rest ...args: object[]
Returns object

mergeDefaults

mergeDefaults<T>(a: T, b: Partial<T>): T

- Defined in types/utils/object.d.ts:10
Deeply merges object b into a. Mutates a.

Same concept as _.merge, but doesn't overwrite properties that have already been assigned.

Type parameters
- T
Parameters
- a: T
- b: Partial<T>
Returns T

Private nameIndex

nameIndex(index: NameIndexIndex, tableName: NameIndexTableName): NameIndexIndex

- Defined in types/utils/string.d.ts:30
Parameters
- index: NameIndexIndex
- tableName: NameIndexTableName
Returns NameIndexIndex

now

now(dialect: string): Date

- Defined in types/utils/dialect.d.ts:1
Parameters
- dialect: string
Returns Date

pluralize

pluralize(str: string): string

- Defined in types/utils/string.d.ts:10
Parameters
- str: string
Returns string

removeNullishValuesFromHash

removeNullishValuesFromHash(hash: Record<string, any>, omitNull: boolean, options?: { allowNull?: string[] }): Record<string, any>

- Defined in types/utils/format.d.ts:63
Removes entries from hash whose value is either null or undefined, unless omitNull is false or allowNull includes that key.

Keys ending with 'Id' are never removed.

Parameters
- hash: Record<string, any>
  
  the object from which entries with nullish values will be removed.
- omitNull: boolean
  
  if false, this method returns the object as-is
- Optional options: { allowNull?: string[] }
  - Optional allowNull?: string[]
    
    A list of keys that must be preserved even if their value is null or undefined.
Returns Record<string, any>

removeTicks

removeTicks(s: string, tickChar?: string): string

- Defined in types/utils/dialect.d.ts:5
Parameters
- s: string
- Optional tickChar: string
Returns string

removeTrailingSemicolon

removeTrailingSemicolon(str: string): string

- Defined in types/utils/string.d.ts:40
Parameters
- str: string
Returns string

safeStringifyJson

safeStringifyJson(stringifyTarget: any): string

- Defined in types/utils/string.d.ts:39
Stringify a value as JSON with some differences:
- bigints are stringified as a json string. (safeStringifyJson({ val: 1n }) outputs '{ "val": "1" }'). This is because of a decision by TC39 to not support bigint in JSON.stringify https://github.com/tc39/proposal-bigint/issues/24
Parameters
- stringifyTarget: any
  
  the value to stringify.
Returns string
the resulting json.

singularize

singularize(str: string): string

- Defined in types/utils/string.d.ts:9
Parameters
- str: string
Returns string

spliceStr

spliceStr(str: string, index: number, count: number, add: string): string

- Defined in types/utils/string.d.ts:8
Parameters
- str: string
- index: number
- count: number
- add: string
Returns string

toDefaultValue

toDefaultValue(value: unknown, dialect: string): unknown

- Defined in types/utils/dialect.d.ts:2
Parameters
- value: unknown
- dialect: string
Returns unknown

underscore

underscore(str: string): string

- Defined in types/utils/string.d.ts:7
Parameters
- str: string
Returns string

underscoredIf

underscoredIf(str: string, condition: boolean): string

- Defined in types/utils/string.d.ts:6
Parameters
- str: string
- condition: boolean
Returns string

useInflection

useInflection(newInflection: Inflection): void

- Defined in types/utils/string.d.ts:3
Parameters
- newInflection: Inflection
Returns void

Index

Classes

Type aliases

Variables

Functions

Type aliases

AllowArray

Type parameters

T

AllowReadonlyArray

Type parameters

T

AnyFunction

Type declaration

Parameters

Rest ...args: any[]

Returns any

DeepWriteable

Type parameters

T

FinderOptions

Type parameters

TAttributes

Type declaration

Optional attributes?: string[]

Optional where?: WhereOptions<TAttributes>

MakeNullishOptional

Type parameters

T: object

MappedFinderOptions

Type parameters

TAttributes

Nullish

Type parameters

T

NullishPropertiesOf

Type parameters

T

PartlyRequired

Type parameters

T

K: keyof T

Variables

Const TICK_CHAR

Functions

addTicks

Parameters

s: string

Optional tickChar: string

Returns string

camelize

Parameters

str: string

Returns string

camelizeIf

Parameters

str: string

condition: boolean

Returns string

Private camelizeObjectKeys

Parameters

obj: {}

[key: string]: any

Returns {}

[key: string]: any

canTreatArrayAsAnd

Parameters

arr: unknown[]

Returns arr is (object | Where<typeof eq>)[]

Private classToInvokable

Type parameters

Class: new (...args: any[]) => any

Parameters

constructor: Class

Returns Callable<Class>

cloneDeep

Type parameters

T: object

Parameters

obj: T