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

One-to-one association. See hasOne

This is almost the same as BelongsTo, 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 hasOne has been called, on which the association methods will be added.
T extends Model = Model

The model passed to 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

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

Index

Constructors

constructor

new HasOne<S, T, SourceKey, TargetKey, TargetPrimaryKey>(secret: symbol, source: ModelStatic<S>, target: ModelStatic<T>, options: NormalizedHasOneOptions<SourceKey, TargetKey>, parent?: Association<Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>>): HasOne<S, T, SourceKey, TargetKey, TargetPrimaryKey>
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
- 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>>
Returns HasOne<S, T, SourceKey, TargetKey, TargetPrimaryKey>
Overrides Association.constructor
- Defined in types/associations/has-one.d.ts:44

Properties

`Private` #private

#private: any

`Readonly` accessors

accessors: SingleAssociationAccessors

`Readonly` inverse

inverse: BelongsTo<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 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

foreignKey

get foreignKey(): TargetKey
Returns TargetKey
Overrides Association.foreignKey
- Defined in types/associations/has-one.d.ts:23

identifierField

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

Returns string
- Defined in types/associations/has-one.d.ts:27

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

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 targetKey). The foreignKey is on the Target Model.

Returns SourceKey
- Defined in types/associations/has-one.d.ts:33

sourceKeyAttribute

get sourceKeyAttribute(): SourceKey
Deprecated
use sourceKey

Returns SourceKey
- Defined in types/associations/has-one.d.ts:41

sourceKeyField

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

Returns string
- Defined in types/associations/has-one.d.ts:37

`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?: 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.

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

get

get(instances: S, options?: HasOneGetAssociationMixinOptions<T>): 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 types/associations/has-one.d.ts:55
get(instances: S[], options?: HasOneGetAssociationMixinOptions<T>): Promise<Map<any, null | T>>
Parameters
- instances: S[]
- Optional options: HasOneGetAssociationMixinOptions<T>
Returns Promise<Map<any, null | T>>
- Defined in types/associations/has-one.d.ts:56

set

set(sourceInstance: S, associatedInstanceOrPk: T | T[TargetPrimaryKey], options?: HasOneSetAssociationMixinOptions<T>): Promise<T>
Set the associated model.

Returns
The associated instance, or null if disassociated.
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>
- Defined in types/associations/has-one.d.ts:66
set(sourceInstance: S, associatedInstanceOrPk: null, options?: HasOneSetAssociationMixinOptions<T>): Promise<null>
Parameters
- sourceInstance: S
- associatedInstanceOrPk: null
- Optional options: HasOneSetAssociationMixinOptions<T>
Returns Promise<null>
- Defined in types/associations/has-one.d.ts:67

`Static` associate

associate<S, T, SourceKey, TargetKey>(secret: symbol, source: ModelStatic<S>, target: ModelStatic<T>, options?: HasOneOptions<SourceKey, TargetKey>, parent?: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>): HasOne<S, T, SourceKey, TargetKey, any>
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: HasOneOptions<SourceKey, TargetKey>
- Optional parent: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>
Returns HasOne<S, T, SourceKey, TargetKey, any>
- Defined in types/associations/has-one.d.ts:45

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

Type Parameters

S extends Model = Model

T extends Model = Model

SourceKey extends AttributeNames<S> = any

TargetKey extends AttributeNames<T> = any

TargetPrimaryKey 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

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

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

Properties

Private #private

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

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

sourceKey

Returns SourceKey

sourceKeyAttribute

Deprecated

Returns SourceKey

sourceKeyField

Returns string

Static isMultiAssociation

Returns boolean

Methods

create

Returns

Parameters

sourceInstance: S

Optional values: CreationAttributes<T>

Optional options: HasOneCreateAssociationMixinOptions<T>

Returns Promise<T>

get

Parameters

instances: S

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

`Private` #private

`Readonly` accessors

`Readonly` inverse

`Readonly` options

`Readonly` parentAssociation

Returns {
plural: string;
singular: string;
}

`Static` isMultiAssociation

`Optional` values: CreationAttributes<T>

`Optional` options: HasOneCreateAssociationMixinOptions<T>

`Optional` options: HasOneGetAssociationMixinOptions<T>

`Optional` options: HasOneGetAssociationMixinOptions<T>

`Optional` options: HasOneSetAssociationMixinOptions<T>

`Optional` options: HasOneSetAssociationMixinOptions<T>

`Static` associate

`Optional` options: HasOneOptions<SourceKey, TargetKey>

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