Class ModelSetView<Dialect>

Type Parameters

Dialect extends AbstractDialect

Hierarchy (View Summary)

SetView<ModelStatic>
- ModelSetView

Index

Constructors

Accessors

Methods

[iterator] find firstValue get getModelsTopoSortedByForeignKey getNames getOrThrow has hasByName toMutableSet values

Constructors

constructor

new ModelSetView<Dialect extends AbstractDialect<object, object>>(
sequelize: SequelizeTypeScript<Dialect>,
set: Set<ModelStatic>,
): ModelSetView<Dialect>
Type Parameters
- Dialect extends AbstractDialect<object, object>
Parameters
- sequelize: SequelizeTypeScript<Dialect>
- set: Set<ModelStatic>
Returns ModelSetView<Dialect>
Overrides SetView.constructor
- Defined in packages/core/src/model-set-view.ts:12

Accessors

size

get size(): number
Returns number
the number of (unique) elements in Set.
Inherited from SetView.size
- Defined in packages/utils/lib/common/set/set-view.d.ts:7

Methods

[iterator]

"[iterator]"(): IterableIterator<ModelStatic>
Returns IterableIterator<ModelStatic>
Inherited from SetView.[iterator]
- Defined in packages/utils/lib/common/set/set-view.d.ts:15

find

find(callback: (model: ModelStatic) => boolean): undefined | ModelStatic
Parameters
- callback: (model: ModelStatic) => boolean
Returns undefined | ModelStatic
Inherited from SetView.find
- Defined in packages/utils/lib/common/set/set-view.d.ts:14

firstValue

firstValue(): undefined | ModelStatic
Returns undefined | ModelStatic
Inherited from SetView.firstValue
- Defined in packages/utils/lib/common/set/set-view.d.ts:18

get

get<M extends Model<any, any> = Model<any, any>>(
modelName: string,
): undefined | ModelStatic<M>
Type Parameters
- M extends Model<any, any> = Model<any, any>
Parameters
- modelName: string
Returns undefined | ModelStatic<M>
- Defined in packages/core/src/model-set-view.ts:18

getModelsTopoSortedByForeignKey

getModelsTopoSortedByForeignKey(): null | ModelStatic[]
Returns an array that lists every model, sorted in order of foreign key references: The first model is a model that is depended upon, the last model is a model that is not depended upon.

If there is a cyclic dependency, this returns null.

Returns null | ModelStatic[]
- Defined in packages/core/src/model-set-view.ts:52

getNames

getNames(): Iterable<string>
Returns the list of registered model names.

Returns Iterable<string>
- Defined in packages/core/src/model-set-view.ts:37

getOrThrow

getOrThrow<M extends Model<any, any> = Model<any, any>>(
modelName: string,
): ModelStatic<M>
Type Parameters
- M extends Model<any, any> = Model<any, any>
Parameters
- modelName: string
Returns ModelStatic<M>
- Defined in packages/core/src/model-set-view.ts:24

has

has(value: ModelStatic): boolean
Parameters
- value: ModelStatic
Returns boolean
a boolean indicating whether an element with the specified value exists in the Set or not.
Inherited from SetView.has
- Defined in packages/utils/lib/common/set/set-view.d.ts:13

hasByName

hasByName(modelName: string): boolean
Parameters
- modelName: string
Returns boolean
- Defined in packages/core/src/model-set-view.ts:41

toMutableSet

toMutableSet(): Set<ModelStatic>
Returns Set<ModelStatic>
Inherited from SetView.toMutableSet
- Defined in packages/utils/lib/common/set/set-view.d.ts:17

values

values(): IterableIterator<ModelStatic>
Returns IterableIterator<ModelStatic>
Inherited from SetView.values
- Defined in packages/utils/lib/common/set/set-view.d.ts:16