Class BelongsToAssociation<S, T, SourceKey, TargetKey>

One-to-one association See Model.belongsTo

This is almost the same as HasOneAssociation, but the foreign key will be defined on the source model.

In the API reference below, add the name of the association to the method, e.g. for User.belongsTo(Project) the getter will be user.getProject().

Type Parameters

S extends Model = Model
The model on which Model.belongsTo has been called, on which the association methods, as well as the foreign key attribute, will be added.
T extends Model = Model
The model passed to Model.belongsTo.
SourceKey extends AttributeNames<S> = any
The name of the Foreign Key attribute on the Source model.
TargetKey extends AttributeNames<T> = any
The name of the attribute that the foreign key in the source model will reference, typically the Primary Key.

Hierarchy (view full)

Association<S, T, SourceKey, NormalizedBelongsToOptions<SourceKey, TargetKey>>
- BelongsToAssociation

Constructors

constructor

new BelongsToAssociation<S, T, SourceKey, TargetKey>(secret, source, target, options, parent?): BelongsToAssociation<S, T, SourceKey, TargetKey>
Type Parameters
- S extends Model<any, any> = Model<any, any>
- T extends Model<any, any> = Model<any, any>
- SourceKey extends string = any
- TargetKey extends string = any
Parameters
- secret: symbol
- source: ModelStatic<S>
- target: ModelStatic<T>
- options: NormalizedBelongsToOptions<SourceKey, TargetKey>
- Optional parent: Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>
Returns BelongsToAssociation<S, T, SourceKey, TargetKey>
Overrides Association.constructor
- Defined in packages/core/src/associations/belongs-to.ts:94

Properties

`Readonly` accessors

accessors: SingleAssociationAccessors

foreignKey

foreignKey: SourceKey

identifierField

identifierField: string

The column name of the foreign key

inverse

inverse: undefined | Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>

isAliased

isAliased: boolean

isSelfAssociation

isSelfAssociation: boolean

`Readonly` options

options: NormalizedBelongsToOptions<SourceKey, TargetKey>

`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>

targetKey

targetKey: TargetKey

The name of the attribute the foreign key points to. In belongsTo, this key is on the Target Model, instead of the Source Model (unlike HasOneAssociation.sourceKey). The Association.foreignKey is on the Source Model.

`Readonly` targetKeyField

targetKeyField: string

The column name of the target key

`Readonly` targetKeyIsPrimary

targetKeyIsPrimary: boolean

Accessors

as

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

Returns string
Inherited from Association.as
- Defined in packages/core/src/associations/base.ts:181

associationType

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

Returns string
Inherited from Association.associationType
- Defined in packages/core/src/associations/base.ts:129

identifier

get identifier(): string
The attribute name of the identifier

Returns string
Deprecated
use foreignKey instead
- Defined in packages/core/src/associations/belongs-to.ts:58

isMultiAssociation

get isMultiAssociation(): boolean
Returns boolean
Inherited from Association.isMultiAssociation
- Defined in packages/core/src/associations/base.ts:133

isSingleAssociation

get isSingleAssociation(): boolean
Returns boolean
Deprecated
negate isMultiAssociation instead
Inherited from Association.isSingleAssociation
- Defined in packages/core/src/associations/base.ts:140

name

get name(): {
plural: string;
singular: string;
}
Returns {
plural: string;
singular: string;
}
- plural: string
- singular: string
Inherited from Association.name
- Defined in packages/core/src/associations/base.ts:185

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 packages/core/src/associations/base.ts:116

scope

get scope(): undefined | AssociationScope
Returns undefined | AssociationScope
Inherited from Association.scope
- Defined in packages/core/src/associations/base.ts:189

targetIdentifier

get targetIdentifier(): string
Returns string
Deprecated
use BelongsToAssociation.targetKey
- Defined in packages/core/src/associations/belongs-to.ts:88

`Static` isMultiAssociation

get isMultiAssociation(): boolean
Returns boolean
Inherited from Association.isMultiAssociation
- Defined in packages/core/src/associations/base.ts:144

Methods

`Private` #mixin

#mixin(modelPrototype): void
Parameters
- modelPrototype: Model<any, any>
Returns void
- Defined in packages/core/src/associations/belongs-to.ts:290

create

create(sourceInstance, values?, options?): Promise<T>
Create a new instance of the associated model and associate it with this.
Parameters
- sourceInstance: S
  the source instance
- values: CreationAttributes<T> = {}
  values to create associated model instance with
- options: BelongsToCreateAssociationMixinOptions<T> = {}
  Options passed to target.create and setAssociation.
Returns Promise<T>
The created target model
- Defined in packages/core/src/associations/belongs-to.ts:424

get

get(instances, options?): Promise<null | T>
Get the associated instance.

See BelongsToGetAssociationMixinOptions for a full explanation of options. This method is mixed-in the source model prototype. See BelongsToGetAssociationMixin.
Parameters
- instances: S
  source instances
- Optional options: BelongsToGetAssociationMixinOptions<T>
  find options
Returns Promise<null | T>
- Defined in packages/core/src/associations/belongs-to.ts:312
get(instances, options?): Promise<Map<any, null | T>>
Parameters
- instances: S[]
- Optional options: BelongsToGetAssociationMixinOptions<T>
Returns Promise<Map<any, null | T>>
- Defined in packages/core/src/associations/belongs-to.ts:313

`Protected` inferForeignKey

inferForeignKey(): string
Returns string
- Defined in packages/core/src/associations/belongs-to.ts:294

set

set(sourceInstance, associatedInstance, options?): Promise<void>
Set the associated model.
Parameters
- sourceInstance: S
  the source instance
- associatedInstance: null | T | T[TargetKey]
  An persisted instance or the primary key of an instance to associate with this. Pass null to remove the association.
- options: BelongsToSetAssociationMixinOptions<T> = {}
  options passed to this.save
Returns Promise<void>
- Defined in packages/core/src/associations/belongs-to.ts:390

`Static` associate

associate<S, T, SourceKey, TargetKey>(secret, source, target, options?, parent?): BelongsToAssociation<S, T, SourceKey, TargetKey>
Type Parameters
- S extends Model<any, any>
- T extends Model<any, any>
- SourceKey extends string
- TargetKey extends string
Parameters
- secret: symbol
- source: ModelStatic<S>
- target: ModelStatic<T>
- options: BelongsToOptions<SourceKey, TargetKey> = {}
- Optional parent: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>
Returns BelongsToAssociation<S, T, SourceKey, TargetKey>
- Defined in packages/core/src/associations/belongs-to.ts:249

Class BelongsToAssociation<S, T, SourceKey, TargetKey>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BelongsToAssociation<S, T, SourceKey, TargetKey>

Properties

Readonly accessors

foreignKey

identifierField

inverse

isAliased

isSelfAssociation

Readonly options

Readonly parentAssociation

source

target

targetKey

Readonly targetKeyField

Readonly targetKeyIsPrimary

Accessors

as

Returns string

associationType

Returns string

identifier

Returns string

Deprecated

isMultiAssociation

Returns boolean

isSingleAssociation

Returns boolean

Deprecated

name

Returns { plural: string; singular: string; }

plural: string

singular: string

rootAssociation

Returns Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>

scope

Returns undefined | AssociationScope

targetIdentifier

Returns string

Deprecated

Static isMultiAssociation

Returns boolean

Methods

Private #mixin

Parameters

Returns void

create

Parameters

Returns Promise<T>

get

Parameters

Returns Promise<null | T>

Parameters

Returns Promise<Map<any, null | T>>

Protected inferForeignKey

Returns string

set

Parameters

Returns Promise<void>

Static associate

Type Parameters

Parameters

Returns BelongsToAssociation<S, T, SourceKey, TargetKey>

Settings

Member Visibility

Theme

On This Page

`Readonly` accessors

`Readonly` options

`Readonly` parentAssociation

`Readonly` targetKeyField

`Readonly` targetKeyIsPrimary

Returns {
plural: string;
singular: string;
}

`Static` isMultiAssociation

`Private` #mixin

`Protected` inferForeignKey

`Static` associate