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> = AttributeNames<S>
The name of the attribute that the foreign key in the target model will reference.
TargetKey extends AttributeNames<T> = AttributeNames<T>
The name of the Foreign Key attribute on the Target model.
TargetPrimaryKey extends AttributeNames<T> = AttributeNames<T>
The name of the Primary Key attribute of the Target model. Used by HasOneSetAssociationMixin.

Hierarchy (View Summary)

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

Index

Constructors

constructor

new HasOneAssociation<
    S extends Model<any, any> = Model<any, any>,
    T extends Model<any, any> = Model<any, any>,
    SourceKey extends string = AttributeNames<S>,
    TargetKey extends string = AttributeNames<T>,
    TargetPrimaryKey extends string = AttributeNames<T>,
>(
    secret: symbol,
    source: ModelStatic<S>,
    target: ModelStatic<T>,
    options: NormalizedHasOneOptions<SourceKey, TargetKey>,
    parent?: Association<
        Model<any, any>,
        Model<any, any>,
        string,
        NormalizedAssociationOptions<string>,
    >,
    inverse?: BelongsToAssociation<T, S, TargetKey, SourceKey>,
): HasOneAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>
Type Parameters
- S extends Model<any, any> = Model<any, any>
  The model on which Model.hasOne has been called, on which the association methods will be added.
- T extends Model<any, any> = Model<any, any>
  The model passed to Model.hasOne. This model will receive the Foreign Key attribute.
- SourceKey extends string = AttributeNames<S>
  The name of the attribute that the foreign key in the target model will reference.
- TargetKey extends string = AttributeNames<T>
  The name of the Foreign Key attribute on the Target model.
- TargetPrimaryKey extends string = AttributeNames<T>
  The name of the Primary Key attribute of the Target model. Used by HasOneSetAssociationMixin.
Parameters
- secret: symbol
- source: ModelStatic<S>
- target: ModelStatic<T>
- options: NormalizedHasOneOptions<SourceKey, TargetKey>
- Optionalparent: Association<
      Model<any, any>,
      Model<any, any>,
      string,
      NormalizedAssociationOptions<string>,
  >
- Optionalinverse: BelongsToAssociation<T, S, TargetKey, SourceKey>
Returns HasOneAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>
Overrides Association.constructor
- Defined in 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

`Readonly`parentAssociation

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

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

associationType

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

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

foreignKey

get foreignKey(): TargetKey
The name of the foreign key attribute used by this association.

Returns TargetKey
Overrides Association.foreignKey
- Defined in 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 core/src/associations/has-one.ts:58

isMultiAssociation

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

isSingleAssociation

get isSingleAssociation(): boolean
Returns boolean

Deprecated
negate isMultiAssociation instead
Inherited from Association.isSingleAssociation
- Defined in core/src/associations/base.ts:143

name

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

rootAssociation

get rootAssociation(): Association
Creating an associations can automatically create other associations. This returns the initial association that caused the creation of the descendant associations.

Returns Association
Inherited from Association.rootAssociation
- Defined in core/src/associations/base.ts:119

scope

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

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 core/src/associations/has-one.ts:67

sourceKeyAttribute

get sourceKeyAttribute(): SourceKey
Returns SourceKey

Deprecated
use sourceKey
- Defined in core/src/associations/has-one.ts:81

sourceKeyField

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

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

`Static`isMultiAssociation

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

Methods

create

create(
    sourceInstance: S,
    values?: CreationAttributes<T>,
    options?: HasOneCreateAssociationMixinOptions<T>,
): 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 core/src/associations/has-one.ts:372

get

get(
instances: S,
options?: HasOneGetAssociationMixinOptions<T>,
): Promise<T | null>
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
- Optionaloptions: HasOneGetAssociationMixinOptions<T>
  find options
Returns Promise<T | null>
- Defined in core/src/associations/has-one.ts:197
get(
instances: S[],
options?: HasOneGetAssociationMixinOptions<T>,
): Promise<Map<any, T | null>>
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
- Optionaloptions: HasOneGetAssociationMixinOptions<T>
  find options
Returns Promise<Map<any, T | null>>
- Defined in core/src/associations/has-one.ts:198

set

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

`Static`associate

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

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

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Readonlyaccessors

Readonlyinverse

isAliased

isSelfAssociation

Readonlyoptions

ReadonlyparentAssociation

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 }

rootAssociation

Returns Association

scope

Returns AssociationScope | undefined

sourceKey

Returns SourceKey

sourceKeyAttribute

Returns SourceKey

Deprecated

sourceKeyField

Returns string

StaticisMultiAssociation

Returns boolean

Methods

create

Parameters

Returns Promise<T>

get

Parameters

Returns Promise<T | null>

Parameters

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

set

Parameters

Returns Promise<T>

Parameters

Returns Promise<null>

Staticassociate

Type Parameters

Parameters

Returns HasOneAssociation<S, T, SourceKey, TargetKey>

Settings

On This Page

`Readonly`accessors

`Readonly`inverse

`Readonly`options

`Readonly`parentAssociation

`Static`isMultiAssociation

`Static`associate