BelongsTo

One-to-one association

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().

Method Summary

Public Methods
public	async create(sourceInstance: Model, values: object, options: object): Promise<Model> Create a new instance of the associated model and associate it with this.
public	async get(instances: Model \| Array<Model>, options: object): Promise<Model> Get the associated instance.
public	async set(sourceInstance: Model, associatedInstance: <Model> \| string \| number, options: object): Promise Set the associated model.

From class Association
public	associationType: string The type of the association.
public	source: Model
public	target: Model

Create a new instance of the associated model and associate it with this.

Name	Type	Attribute	Description
sourceInstance	Model		the source instance
values	object	optional default: {}	values to create associated model instance with
options	object	optional default: {}	Options passed to `target.create` and setAssociation.

The created target model

Get the associated instance.

Name	Type	Attribute	Description
instances	Model \| Array<Model>		source instances
options	object	optional	find options
options.scope	string \| boolean	optional	Apply a scope on the related model, or remove its default scope by passing false.
options.schema	string	optional	Apply a schema on the related model

Set the associated model.

Name	Type	Attribute	Description
sourceInstance	Model		the source instance
associatedInstance	<Model> \| string \| number	optional nullable: true	An persisted instance or the primary key of an instance to associate with this. Pass `null` or `undefined` to remove the association.
options	object	optional default: {}	options passed to `this.save`
options.save	boolean	optional default: true	Skip saving this after setting the foreign key if false.