Class MultiAssociation<S, T, ForeignKey, TargetKey, Opts>`Abstract` `Private`

Type Parameters

S extends Model = Model
T extends Model = Model
ForeignKey extends string = string
TargetKey extends AttributeNames<T> = any
Opts extends NormalizedAssociationOptions<ForeignKey> = NormalizedAssociationOptions<ForeignKey>

Hierarchy

Association<S, T, ForeignKey, Opts>
- MultiAssociation
  - HasMany
  - BelongsToMany

Index

Constructors

Properties

accessors foreignKey isAliased isSelfAssociation options parentAssociation source target

Accessors

as associationType isMultiAssociation isSingleAssociation name rootAssociation scope isMultiAssociation

Methods

toInstanceArray

Constructors

constructor

new MultiAssociation<S, T, ForeignKey, TargetKey, Opts>(secret: symbol, source: ModelStatic<S>, target: ModelStatic<T>, options: Opts, parent?: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>): MultiAssociation<S, T, ForeignKey, TargetKey, Opts>
Type Parameters
- S extends Model<any, any, S> = Model<any, any>
- T extends Model<any, any, T> = Model<any, any>
- ForeignKey extends string = string
- TargetKey extends string = any
- Opts extends NormalizedAssociationOptions<ForeignKey> = NormalizedAssociationOptions<ForeignKey>
Parameters
- secret: symbol
- source: ModelStatic<S>
- target: ModelStatic<T>
- options: Opts
- Optional parent: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>
Returns MultiAssociation<S, T, ForeignKey, TargetKey, Opts>
Inherited from Association.constructor
- Defined in types/associations/base.d.ts:111

Properties

`Abstract` accessors

accessors: Record<string, string>

`Abstract` foreignKey

foreignKey: ForeignKey

isAliased

isAliased: boolean

isSelfAssociation

isSelfAssociation: boolean

`Readonly` options

options: Opts

`Readonly` parentAssociation

parentAssociation: null | Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>

A reference to the association that created this one.

source

source: ModelStatic<S>

target

target: ModelStatic<T>

Accessors

as

get as(): string
The identifier of the relation on the source model.

Returns string
Inherited from Association.as
- Defined in types/associations/base.d.ts:115

associationType

get associationType(): string
The type of the association. One of HasMany, BelongsTo, HasOne, BelongsToMany

Returns string
Inherited from Association.associationType
- Defined in types/associations/base.d.ts:104

isMultiAssociation

get isMultiAssociation(): boolean
Returns boolean
Inherited from Association.isMultiAssociation
- Defined in types/associations/base.d.ts:105

isSingleAssociation

get isSingleAssociation(): boolean
Deprecated
negate isMultiAssociation instead

Returns boolean
Inherited from Association.isSingleAssociation
- Defined in types/associations/base.d.ts:109

name

get name(): {
plural: string;
singular: string;
}
Returns {
plural: string;
singular: string;
}
- plural: string
- singular: string
Inherited from Association.name
- Defined in types/associations/base.d.ts:116

rootAssociation

get rootAssociation(): Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>
Creating an associations can automatically create other associations. This returns the initial association that caused the creation of the descendant associations.

Returns Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>
Inherited from Association.rootAssociation
- Defined in types/associations/base.d.ts:98

scope

get scope(): undefined | AssociationScope
Returns undefined | AssociationScope
Inherited from Association.scope
- Defined in types/associations/base.d.ts:120

`Static` isMultiAssociation

get isMultiAssociation(): boolean
Returns boolean
Overrides Association.isMultiAssociation
- Defined in types/associations/base.d.ts:126

Methods

`Private` toInstanceArray

toInstanceArray(input: AllowArray<T | Exclude<T[TargetKey], any[]>>): T[]
Private
Normalize input

Returns
built objects
Parameters
- input: AllowArray<T | Exclude<T[TargetKey], any[]>>
  
  it may be array or single obj, instance or primary key
Returns T[]
- Defined in types/associations/base.d.ts:135

Generated using TypeDoc