指南 參考 原始碼
public class | 原始碼

BelongsTo

繼承自

Association → BelongsTo

一對一關聯

在下方的 API 參考中，將關聯名稱加入方法中，例如，針對 User.belongsTo(Project)，getter 會是 user.getProject()。

請參閱

方法摘要

公共方法
public

async create(sourceInstance: Model, values: object, options: object): Promise<Model>

建立相關模型的新實例，並將其與此模型關聯。
public

async get(instances: Model | Array<Model>, options: object): Promise<Model>

取得關聯的實例。
public

async set(sourceInstance: Model, associatedInstance: Model | string | number, options: object): Promise

設定關聯的模型。

繼承摘要

來自類別 Association
public

關聯的類型。
public
public

公共方法

public async create(sourceInstance: Model, values: object, options: object): Promise<Model> 原始碼

建立相關模型的新實例，並將其與此模型關聯。

參數

名稱類型屬性描述
sourceInstance Model

來源實例
values object
  • 可選
  • 預設值：{}

用於建立關聯模型實例的值
options object
  • 可選
  • 預設值：{}

傳遞給 target.create 和 setAssociation 的選項。

回傳

Promise<Model>

建立的目標模型

請參閱

  • 關於選項的完整說明，請參閱 Model#create

public async get(instances: Model | Array<Model>, options: object): Promise<Model> 原始碼

取得關聯的實例。

參數

名稱類型屬性描述
instances Model | Array<Model>

來源實例
options object
  • 可選

查找選項
options.scope string | boolean
  • 可選

在相關模型上套用 scope，或傳遞 false 來移除其預設 scope。
options.schema string
  • 可選

在相關模型上套用 schema

回傳

Promise<Model>

請參閱

public async set(sourceInstance: Model, associatedInstance: Model | string | number, options: object): Promise 原始碼

設定關聯的模型。

參數

名稱類型屬性描述
sourceInstance Model

來源實例
associatedInstance Model | string | number
  • 可選
  • 可為 null: true

要與此關聯的持久化實例或實例的主鍵。傳遞 null 或 undefined 以移除關聯。
options object
  • 可選
  • 預設值：{}

傳遞給 this.save 的選項
options.save boolean
  • 可選
  • 預設值：true

如果為 false，則在設定外鍵後跳過儲存此項。

回傳

Promise