Class ModelSetView

Hierarchy (view full)

SetView<ModelStatic>
- ModelSetView

Index

Constructors

Properties

#sequelize #target

Accessors

Methods

[custom] [iterator] find forEachModel get getModelsTopoSortedByForeignKey getOrThrow has hasByName toJSON values

Constructors

constructor

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

Properties

`Private` `Readonly` #sequelize

#sequelize: SequelizeTypeScript

`Private` #target

#target: Set<ModelStatic>

Accessors

size

get size(): number
Returns number
the number of (unique) elements in Set.
Inherited from SetView.size
- Defined in packages/core/src/utils/immutability.ts:27

Methods

[custom]

[custom](depth, options): string
Parameters
- depth: number
- options: InspectOptions
Returns string
Inherited from SetView.[custom]
- Defined in packages/core/src/utils/immutability.ts:43

[iterator]

[iterator](): IterableIterator<ModelStatic>
Returns IterableIterator<ModelStatic>
Inherited from SetView.[iterator]
- Defined in packages/core/src/utils/immutability.ts:31

find

find(callback): undefined | ModelStatic
Parameters
- callback: ((model) => boolean)
  - - (model): boolean
    - Parameters
      model: ModelStatic
      Returns boolean
Returns undefined | ModelStatic
Inherited from SetView.find
- Defined in packages/core/src/utils/immutability.ts:20

`Private` forEachModel

forEachModel(iterator, options?): void
Private
Iterate over Models in an order suitable for e.g. creating tables. Will take foreign key constraints into account so that dependencies are visited before dependents.
Parameters
- iterator: ((model) => void)
  method to execute on each model
  - - (model): void
    - Parameters
      model: ModelStatic
      Returns void
- Optional options: {
  reverse?: boolean;
  }
  - Optional reverse?: boolean
Returns void
Deprecated
- Defined in packages/core/src/model-set-view.ts:102

get

get<M>(modelName): 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:17

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:44

getOrThrow

getOrThrow<M>(modelName): 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:23

has

has(value): 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/core/src/utils/immutability.ts:16

hasByName

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

toJSON

toJSON(): ModelStatic[]
Returns ModelStatic[]
Inherited from SetView.toJSON
- Defined in packages/core/src/utils/immutability.ts:39

values

values(): IterableIterator<ModelStatic>
Returns IterableIterator<ModelStatic>
Inherited from SetView.values
- Defined in packages/core/src/utils/immutability.ts:35

Generated using TypeDoc