Class HasOneAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>

One-to-one association. See Model.hasOne

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

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

Type Parameters

S extends Model = Model
The model on which Model.hasOne has been called, on which the association methods will be added.
T extends Model = Model
The model passed to Model.hasOne. This model will receive the Foreign Key attribute.
SourceKey extends AttributeNames<S> = any
The name of the attribute that the foreign key in the target model will reference.
TargetKey extends AttributeNames<T> = any
The name of the Foreign Key attribute on the Target model.
TargetPrimaryKey extends AttributeNames<T> = any
The name of the Primary Key attribute of the Target model. Used by HasOneSetAssociationMixin.

Hierarchy (view full)

Association<S, T, TargetKey, NormalizedHasOneOptions<SourceKey, TargetKey>>
- HasOneAssociation

Index

Constructors

constructor

new HasOneAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>(secret, source, target, options, parent?, inverse?): HasOneAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>
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
- TargetPrimaryKey extends string = any
Parameters
- secret: symbol
- source: ModelStatic<S>
- target: ModelStatic<T>
- options: NormalizedHasOneOptions<SourceKey, TargetKey>
- Optional parent: Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>
- Optional inverse: BelongsToAssociation<T, S, TargetKey, SourceKey>
Returns HasOneAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>
Overrides Association.constructor
- Defined in packages/core/src/associations/has-one.ts:89

Properties

`Readonly` accessors

accessors: SingleAssociationAccessors

`Readonly` inverse

inverse: BelongsToAssociation<T, S, TargetKey, SourceKey>

isAliased

isAliased: boolean

isSelfAssociation

isSelfAssociation: boolean

`Readonly` options

options: NormalizedHasOneOptions<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>

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

foreignKey

get foreignKey(): TargetKey
Returns TargetKey
Overrides Association.foreignKey
- Defined in packages/core/src/associations/has-one.ts:51

identifierField

get identifierField(): string
The column name of the foreign key (on the target model)

Returns string
- Defined in packages/core/src/associations/has-one.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

sourceKey

get sourceKey(): SourceKey
The name of the attribute the foreign key points to. In HasOne, it is on the Source Model, instead of the Target Model (unlike BelongsToAssociation.targetKey). The Association.foreignKey is on the Target Model.

Returns SourceKey
- Defined in packages/core/src/associations/has-one.ts:67

sourceKeyAttribute

get sourceKeyAttribute(): SourceKey
Returns SourceKey
Deprecated
use sourceKey
- Defined in packages/core/src/associations/has-one.ts:81

sourceKeyField

get sourceKeyField(): string
The Column Name of the source key.

Returns string
- Defined in packages/core/src/associations/has-one.ts:74

`Static` isMultiAssociation

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

Methods

`Private` #mixin

#mixin(mixinTargetPrototype): void
Parameters
- mixinTargetPrototype: Model<any, any>
Returns void
- Defined in packages/core/src/associations/has-one.ts:140

create

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

See Model.create for a full explanation of options.
Parameters
- sourceInstance: S
  the source instance
- values: CreationAttributes<T> = {}
  values to create associated model instance with
- options: HasOneCreateAssociationMixinOptions<T> = {}
  Options passed to target.create and setAssociation.
Returns Promise<T>
The created target model
- Defined in packages/core/src/associations/has-one.ts:372

get

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

See HasOneGetAssociationMixinOptions for a full explanation of options. This method is mixed-in the source model prototype. See HasOneGetAssociationMixin.
Parameters
- instances: S
  source instances
- Optional options: HasOneGetAssociationMixinOptions<T>
  find options
Returns Promise<null | T>
- Defined in packages/core/src/associations/has-one.ts:197
get(instances, options?): Promise<Map<any, null | T>>
Parameters
- instances: S[]
- Optional options: HasOneGetAssociationMixinOptions<T>
Returns Promise<Map<any, null | T>>
- Defined in packages/core/src/associations/has-one.ts:198

set

set(sourceInstance, associatedInstanceOrPk, options?): Promise<T>
Set the associated model.
Parameters
- sourceInstance: S
  the source instance
- associatedInstanceOrPk: T | T[TargetPrimaryKey]
  An persisted instance or the primary key of an instance to associate with this. Pass null to remove the association.
- Optional options: HasOneSetAssociationMixinOptions<T>
  Options passed to getAssociation and target.save
Returns Promise<T>
The associated instance, or null if disassociated.
- Defined in packages/core/src/associations/has-one.ts:270
set(sourceInstance, associatedInstanceOrPk, options?): Promise<null>
Parameters
- sourceInstance: S
- associatedInstanceOrPk: null
- Optional options: HasOneSetAssociationMixinOptions<T>
Returns Promise<null>
- Defined in packages/core/src/associations/has-one.ts:275

`Static` associate

associate<S, T, SourceKey, TargetKey>(secret, source, target, options?, parent?, inverse?): HasOneAssociation<S, T, SourceKey, TargetKey, any>
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: HasOneOptions<SourceKey, TargetKey> = {}
- Optional parent: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>
- Optional inverse: BelongsToAssociation<T, S, TargetKey, SourceKey>
Returns HasOneAssociation<S, T, SourceKey, TargetKey, any>
- Defined in packages/core/src/associations/has-one.ts:144

Class HasOneAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HasOneAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>

Properties

Readonly accessors

Readonly inverse

isAliased

isSelfAssociation

Readonly options

Readonly parentAssociation

source

target

Accessors

as

Returns string

associationType

Returns string

foreignKey

Returns TargetKey

identifierField

Returns string

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

sourceKey

Returns SourceKey

sourceKeyAttribute

Returns SourceKey

Deprecated

sourceKeyField

Returns string

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

set

Parameters

Returns Promise<T>

Parameters

Returns Promise<null>

Static associate

Type Parameters

Parameters

Returns HasOneAssociation<S, T, SourceKey, TargetKey, any>

Settings

Member Visibility

Theme

On This Page

`Readonly` accessors

`Readonly` inverse

`Readonly` options

`Readonly` parentAssociation

Returns {
plural: string;
singular: string;
}

`Static` isMultiAssociation

`Private` #mixin

`Static` associate