指南 参考 源代码
public class | 源文件

HasOne

继承自

Association → HasOne

一对一关联

在下面的 API 参考中,将关联名称添加到方法中,例如,对于 User.hasOne(Project),getter 将为 user.getProject()。这与 belongsTo 几乎相同,只有一个例外 - 外键将在目标模型上定义。

参见

方法摘要

公共方法
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>

参见

public 异步 set(sourceInstance: Model, associatedInstance: Model | string | number, options: object): Promise 源文件

设置关联的模型。

参数

名称类型属性描述
sourceInstance Model

源实例

associatedInstance Model | string | number
  • 可选
  • 可为空: true

要与此关联的持久化实例或实例的主键。传递 nullundefined 以删除关联。

options object
  • 可选

传递给 getAssociation 和 target.save 的选项

返回值

Promise