Class: HasOneRelation<Parent, Related, RelatedClass>

Defined in: packages/soukai/src/models/relations/HasOneRelation.ts:5

Extends

• SingleModelRelation<Parent, Related, RelatedClass>

Type Parameters

Parent

Parent extends Model = Model

Related

Related extends Model = Model

RelatedClass

RelatedClass extends ModelConstructor<Related> = ModelConstructor<Related>

Constructors

Constructor

new HasOneRelation<Parent, Related, RelatedClass>(parent, relatedClass, foreignKeyName?, localKeyName?): HasOneRelation<Parent, Related, RelatedClass>

Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:17

Parameters

parent

Parent

relatedClass

RelatedClass

foreignKeyName?

string

localKeyName?

string

Returns

HasOneRelation<Parent, Related, RelatedClass>

Inherited from

SingleModelRelation.constructor

Properties

deleteStrategy

deleteStrategy: RelationDeleteStrategy = null

Defined in: packages/soukai/src/models/relations/Relation.ts:30

Inherited from

SingleModelRelation.deleteStrategy

---

enabled

enabled: boolean = true

Defined in: packages/soukai/src/models/relations/Relation.ts:29

Inherited from

SingleModelRelation.enabled

---

foreignKeyName

foreignKeyName: string

Defined in: packages/soukai/src/models/relations/Relation.ts:27

Inherited from

SingleModelRelation.foreignKeyName

---

localKeyName

localKeyName: string

Defined in: packages/soukai/src/models/relations/Relation.ts:28

Inherited from

SingleModelRelation.localKeyName

---

name

name: string

Defined in: packages/soukai/src/models/relations/Relation.ts:23

Inherited from

SingleModelRelation.name

---

parent

parent: Parent

Defined in: packages/soukai/src/models/relations/Relation.ts:25

Inherited from

SingleModelRelation.parent

---

related?

optional related: null | Related

Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:15

Inherited from

SingleModelRelation.related

---

relatedClass

relatedClass: RelatedClass

Defined in: packages/soukai/src/models/relations/Relation.ts:26

Inherited from

SingleModelRelation.relatedClass

---

inverseRelationClasses

static inverseRelationClasses: Constructor<Relation<Model, Model, ModelConstructor<Model>>>[] = []

Defined in: packages/soukai/src/models/relations/Relation.ts:21

Inherited from

SingleModelRelation.inverseRelationClasses

Accessors

loaded

Get Signature

get loaded(): boolean

Defined in: packages/soukai/src/models/relations/Relation.ts:39

Returns

boolean

Inherited from

SingleModelRelation.loaded

Methods

addRelated()

addRelated(related): void

Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:48

Parameters

related

Related

Returns

void

Inherited from

SingleModelRelation.addRelated

---

attach()

Call Signature

attach(model?): Related

Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:26

Parameters

model?

Related

Returns

Related

Inherited from

SingleModelRelation.attach

Call Signature

attach(attributes): Related

Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:27

Parameters

attributes

Attributes

Returns

Related

Inherited from

SingleModelRelation.attach

---

clone()

clone(options): this

Defined in: packages/soukai/src/models/relations/Relation.ts:93

Parameters

options

Partial = {}

Returns

this

Inherited from

SingleModelRelation.clone

---

disable()

disable(): void

Defined in: packages/soukai/src/models/relations/Relation.ts:51

Returns

void

Inherited from

SingleModelRelation.disable

---

enable()

enable(): void

Defined in: packages/soukai/src/models/relations/Relation.ts:47

Returns

void

Inherited from

SingleModelRelation.enable

---

getLoadedModels()

getLoadedModels(): Related[]

Defined in: packages/soukai/src/models/relations/Relation.ts:79

Returns

Related[]

Inherited from

SingleModelRelation.getLoadedModels

---

getModels()

getModels(): Promise<Related[]>

Defined in: packages/soukai/src/models/relations/Relation.ts:71

Returns

Promise<Related[]>

Inherited from

SingleModelRelation.getModels

---

initializeInverseRelations()

initializeInverseRelations(model): void

Defined in: packages/soukai/src/models/relations/Relation.ts:116

Parameters

model

Related

Returns

void

Inherited from

SingleModelRelation.initializeInverseRelations

---

isEmpty()

isEmpty(): null | boolean

Defined in: packages/soukai/src/models/relations/Relation.ts:67

Returns

null | boolean

Inherited from

SingleModelRelation.isEmpty

---

isInverseOf()

isInverseOf(relation): boolean

Defined in: packages/soukai/src/models/relations/Relation.ts:129

Parameters

relation

Relation

Returns

boolean

Inherited from

SingleModelRelation.isInverseOf

---

isRelated()

isRelated(related): boolean

Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:52

Parameters

related

Related

Returns

boolean

Inherited from

SingleModelRelation.isRelated

---

load()

load(): Promise<null | Related>

Defined in: packages/soukai/src/models/relations/HasOneRelation.ts:11

Returns

Promise<null | Related>

Overrides

SingleModelRelation.load

---

onDelete()

onDelete(strategy): this

Defined in: packages/soukai/src/models/relations/Relation.ts:87

Parameters

strategy

RelationDeleteStrategy

Returns

this

Inherited from

SingleModelRelation.onDelete

---

resolve()

resolve(): Promise<null | Related | Related[]>

Defined in: packages/soukai/src/models/relations/Relation.ts:63

Returns

Promise<null | Related | Related[]>

Deprecated

This method has been renamed to load.

Inherited from

SingleModelRelation.resolve

---

setForeignAttributes()

setForeignAttributes(related): void

Defined in: packages/soukai/src/models/relations/HasOneRelation.ts:23

Parameters

related

Related

Returns

void

Overrides

SingleModelRelation.setForeignAttributes

---

static()

static(): RelationConstructor<HasOneRelation<Parent, Related, RelatedClass>>

Defined in: packages/soukai/src/models/relations/Relation.ts:43

Returns

RelationConstructor<HasOneRelation<Parent, Related, RelatedClass>>

Inherited from

SingleModelRelation.static

---

unload()

unload(): void

Defined in: packages/soukai/src/models/relations/Relation.ts:83

Returns

void

Inherited from

SingleModelRelation.unload