public class | source

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	create(sourceInstance: Model, values: Object, options: Object): Promise<Model> Create a new instance of the associated model and associate it with this.
public	get(instances: Model \| Array<Model>, options: Object): Promise<Model> Get the associated instance.
public	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.