Class: BelongsToOneRelation<Parent, Related, RelatedClass>

Defined in: packages/soukai/src/models/relations/BelongsToOneRelation.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 BelongsToOneRelation<Parent, Related, RelatedClass>(parent, relatedClass, foreignKeyName?, localKeyName?): BelongsToOneRelation<Parent, Related, RelatedClass>

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

Parameters

parent

Parent

relatedClass

RelatedClass

foreignKeyName?

string

localKeyName?

string

Returns

BelongsToOneRelation<Parent, Related, RelatedClass>

Inherited from

SingleModelRelation.constructor

Properties

_related?

protected optional _related?: Related | Related[] | null

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

Inherited from

SingleModelRelation._related

---

deleteStrategy

deleteStrategy: RelationDeleteStrategy = null

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

Inherited from

SingleModelRelation.deleteStrategy

---

enabled

enabled: boolean = true

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

Inherited from

SingleModelRelation.enabled

---

foreignKeyName

foreignKeyName: string

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

Inherited from

SingleModelRelation.foreignKeyName

---

localKeyName

localKeyName: string

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

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:24

Inherited from

SingleModelRelation.parent

---

relatedClass

relatedClass: RelatedClass

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

Inherited from

SingleModelRelation.relatedClass

---

inverseBelongsToRelationClasses

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

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

Inherited from

SingleModelRelation.inverseBelongsToRelationClasses

---

inverseHasRelationClasses

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

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

Inherited from

SingleModelRelation.inverseHasRelationClasses

Accessors

loaded

Get Signature

get loaded(): boolean

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

Returns

boolean

Inherited from

SingleModelRelation.loaded

---

related

Get Signature

get related(): Related | null | undefined

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

Returns

Related | null | undefined

Set Signature

set related(related): void

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

Parameters

related

Related | null | undefined

Returns

void

Inherited from

SingleModelRelation.related

Methods

addRelated()

addRelated(related): void

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

Parameters

related

Related

Returns

void

Inherited from

SingleModelRelation.addRelated

---

attach()

Call Signature

attach(model?): Related

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

Parameters

model?

Related

Returns

Related

Inherited from

SingleModelRelation.attach

Call Signature

attach(attributes): Related

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

Parameters

attributes

Attributes

Returns

Related

Inherited from

SingleModelRelation.attach

---

clearForeignAttributes()

clearForeignAttributes(related): void

Defined in: packages/soukai/src/models/relations/BelongsToOneRelation.ts:36

Parameters

related

Related

Returns

void

Overrides

SingleModelRelation.clearForeignAttributes

---

clearInverseRelations()

clearInverseRelations(model): void

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

Parameters

model

Related

Returns

void

Inherited from

SingleModelRelation.clearInverseRelations

---

clone()

clone(options?): this

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

Parameters

options?

RelationCloneOptions = {}

Returns

this

Inherited from

SingleModelRelation.clone

---

disable()

disable(): void

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

Returns

void

Inherited from

SingleModelRelation.disable

---

enable()

enable(): void

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

Returns

void

Inherited from

SingleModelRelation.enable

---

getLoadedModels()

getLoadedModels(): Related[]

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

Returns

Related[]

Inherited from

SingleModelRelation.getLoadedModels

---

getModels()

getModels(): Promise<Related[]>

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

Returns

Promise<Related[]>

Inherited from

SingleModelRelation.getModels

---

initializeInverseRelations()

initializeInverseRelations(model): void

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

Parameters

model

Related

Returns

void

Inherited from

SingleModelRelation.initializeInverseRelations

---

isEmpty()

isEmpty(): boolean | null

Defined in: packages/soukai/src/models/relations/BelongsToOneRelation.ts:10

Returns

boolean | null

Overrides

SingleModelRelation.isEmpty

---

isInverseOf()

isInverseOf(other): boolean

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

Parameters

other

Relation

Returns

boolean

Inherited from

SingleModelRelation.isInverseOf

---

isRelated()

isRelated(related): boolean

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

Parameters

related

Related

Returns

boolean

Inherited from

SingleModelRelation.isRelated

---

load()

load(): Promise<Related | null>

Defined in: packages/soukai/src/models/relations/BelongsToOneRelation.ts:14

Returns

Promise<Related | null>

Overrides

SingleModelRelation.load

---

onDelete()

onDelete(strategy): this

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

Parameters

strategy

RelationDeleteStrategy

Returns

this

Inherited from

SingleModelRelation.onDelete

---

onRelatedUpdated()

protected onRelatedUpdated(oldValue, newValue): void

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

Parameters

oldValue

Nullable<Model>

newValue

Nullable<Model>

Returns

void

Inherited from

SingleModelRelation.onRelatedUpdated

---

removeRelated()

removeRelated(related): void

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

Parameters

related

Related

Returns

void

Inherited from

SingleModelRelation.removeRelated

---

resolve()

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

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

Returns

Promise<Related | Related[] | null>

Deprecated

This method has been renamed to load.

Inherited from

SingleModelRelation.resolve

---

setForeignAttributes()

setForeignAttributes(related): void

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

Parameters

related

Related

Returns

void

Overrides

SingleModelRelation.setForeignAttributes

---

static()

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

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

Returns

RelationConstructor<BelongsToOneRelation<Parent, Related, RelatedClass>>

Inherited from

SingleModelRelation.static

---

unload()

unload(): void

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

Returns

void

Inherited from

SingleModelRelation.unload