Class BelongsTo<S, T, SourceKey, TargetKey>

One-to-one association See belongsTo

This is almost the same as HasOne, 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 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 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

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

Index

Constructors

constructor

new BelongsTo<S, T, SourceKey, TargetKey>(secret: symbol, source: ModelStatic<S>, target: ModelStatic<T>, options: NormalizedBelongsToOptions<SourceKey, TargetKey>, parent?: Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>): BelongsTo<S, T, SourceKey, TargetKey>
Type Parameters
- S extends Model<any, any, S> = Model<any, any>
- T extends Model<any, any, T> = 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 BelongsTo<S, T, SourceKey, TargetKey>
Overrides Association.constructor
- Defined in types/associations/belongs-to.d.ts:48

Properties

`Private` #private

#private: any

`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 sourceKey). The 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 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

identifier

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

Deprecated
use foreignKey instead

Returns string
- Defined in types/associations/belongs-to.d.ts:26

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

targetIdentifier

get targetIdentifier(): string
Deprecated
use targetKey

Returns string
- Defined in types/associations/belongs-to.d.ts:46

`Static` isMultiAssociation

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

Methods

create

create(sourceInstance: S, values?: CreationAttributes<T>, options?: BelongsToCreateAssociationMixinOptions<T>): Promise<T>
Create a new instance of the associated model and associate it with this.

Returns
The created target model
Parameters
- sourceInstance: S
  
  the source instance
- Optional values: CreationAttributes<T>
  
  values to create associated model instance with
- Optional options: BelongsToCreateAssociationMixinOptions<T>
  
  Options passed to target.create and setAssociation.
Returns Promise<T>
- Defined in types/associations/belongs-to.d.ts:79

get

get(instances: S, options: BelongsToGetAssociationMixinOptions<T>): 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
- options: BelongsToGetAssociationMixinOptions<T>
  
  find options
Returns Promise<null | T>
- Defined in types/associations/belongs-to.d.ts:60
get(instances: S[], options: BelongsToGetAssociationMixinOptions<T>): Promise<Map<any, null | T>>
Parameters
- instances: S[]
- options: BelongsToGetAssociationMixinOptions<T>
Returns Promise<Map<any, null | T>>
- Defined in types/associations/belongs-to.d.ts:61

`Protected` inferForeignKey

inferForeignKey(): string
Returns string
- Defined in types/associations/belongs-to.d.ts:50

set

set(sourceInstance: S, associatedInstance: null | T | T[TargetKey], options?: BelongsToSetAssociationMixinOptions<T>): 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.
- Optional options: BelongsToSetAssociationMixinOptions<T>
  
  options passed to this.save
Returns Promise<void>
- Defined in types/associations/belongs-to.d.ts:69

`Static` associate

associate<S, T, SourceKey, TargetKey>(secret: symbol, source: ModelStatic<S>, target: ModelStatic<T>, options?: BelongsToOptions<SourceKey, TargetKey>, parent?: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>): BelongsTo<S, T, SourceKey, TargetKey>
Type Parameters
- S extends Model<any, any, S>
- T extends Model<any, any, T>
- SourceKey extends string
- TargetKey extends string
Parameters
- secret: symbol
- source: ModelStatic<S>
- target: ModelStatic<T>
- Optional options: BelongsToOptions<SourceKey, TargetKey>
- Optional parent: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>
Returns BelongsTo<S, T, SourceKey, TargetKey>
- Defined in types/associations/belongs-to.d.ts:49

Class BelongsTo<S, T, SourceKey, TargetKey>

Type Parameters

S extends Model = Model

T extends Model = Model

SourceKey extends AttributeNames<S> = any

TargetKey extends AttributeNames<T> = any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

S extends Model<any, any, S> = Model<any, any>

T extends Model<any, any, T> = 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 BelongsTo<S, T, SourceKey, TargetKey>

Properties

Private #private

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

Deprecated

Returns string

isMultiAssociation

Returns boolean

isSingleAssociation

Deprecated

Returns boolean

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

Deprecated

Returns string

Static isMultiAssociation

Returns boolean

Methods

create

Returns

Parameters

sourceInstance: S

Optional values: CreationAttributes<T>

Optional options: BelongsToCreateAssociationMixinOptions<T>

Returns Promise<T>

get

Parameters

instances: S

options: BelongsToGetAssociationMixinOptions<T>

Returns Promise<null | T>

`Optional` parent: Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>

`Private` #private

`Readonly` accessors

`Readonly` options

`Readonly` parentAssociation

`Readonly` targetKeyField

`Readonly` targetKeyIsPrimary

Returns {
plural: string;
singular: string;
}

`Static` isMultiAssociation

`Optional` values: CreationAttributes<T>

`Optional` options: BelongsToCreateAssociationMixinOptions<T>

`Protected` inferForeignKey

`Optional` options: BelongsToSetAssociationMixinOptions<T>

`Static` associate

`Optional` options: BelongsToOptions<SourceKey, TargetKey>

`Optional` parent: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>