ガイド リファレンス ソースコード
public class | ソースコード

BelongsTo

継承

Association → BelongsTo

1対1関連付け

以下のAPIリファレンスのメソッド名に関連付けの名前を追加してください。例えば、User.belongsTo(Project)の場合、ゲッターはuser.getProject()になります。

参照

メソッド概要

公開メソッド
public

非同期 create(sourceInstance: Model, values: object, options: object): Promise<Model>

関連付けられたモデルの新しいインスタンスを作成し、これと関連付けます。
public

非同期 get(instances: Model | Array<Model>, options: object): Promise<Model>

関連付けられたインスタンスを取得します。
public

非同期 set(sourceInstance: Model, associatedInstance: Model | string | number, options: object): Promise

関連付けられたモデルを設定します。

継承概要

クラス Association から
public

関連付けの種類。
public
public

公開メソッド

public 非同期 create(sourceInstance: Model, values: object, options: object): Promise<Model> ソース

関連付けられたモデルの新しいインスタンスを作成し、これと関連付けます。

パラメータ

名前型属性説明
sourceInstance Model

ソースインスタンス
values object
  • オプション
  • デフォルト: {}

関連付けられたモデルインスタンスを作成する値
options object
  • オプション
  • デフォルト: {}

target.create と setAssociation に渡されるオプション。

戻り値

Promise<Model>

作成されたターゲットモデル

参照

  • オプションの詳細はModel#createを参照してください。

public 非同期 get(instances: Model | Array<Model>, options: object): Promise<Model> ソース

関連付けられたインスタンスを取得します。

パラメータ

名前型属性説明
instances Model | Array<Model>

ソースインスタンス
options object
  • オプション

検索オプション
options.scope string | boolean
  • オプション

関連モデルにスコープを適用するか、false を渡してデフォルトスコープを削除します。
options.schema string
  • オプション

関連モデルにスキーマを適用します。

戻り値

Promise<Model>

参照

  • Model.findOne を参照してオプションの詳細を確認してください。

public 非同期 set(sourceInstance: Model, associatedInstance: Model | string | number, options: object): Promise ソース

関連付けられたモデルを設定します。

パラメータ

名前型属性説明
sourceInstance Model

ソースインスタンス
associatedInstance Model | string | number
  • オプション
  • nullable: true

永続化されたインスタンス、または関連付けるインスタンスの主キー。関連付けを削除するにはnullまたはundefinedを渡します。
options object
  • オプション
  • デフォルト: {}

this.saveに渡されるオプション
options.save boolean
  • オプション
  • デフォルト: true

falseの場合、外部キーの設定後に保存をスキップします。

戻り値

Promise