Skip to content

Class: HasOneRelation<Parent, Related, RelatedClass>

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

Extends

Type Parameters

Parent

Parent extends Model = Model

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

Parameters

parent

Parent

relatedClass

RelatedClass

foreignKeyName?

string

localKeyName?

string

Returns

HasOneRelation<Parent, Related, RelatedClass>

Inherited from

SingleModelRelation.constructor

Properties

protected optional _related: null | Related | Related[]

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

Inherited from

SingleModelRelation._related


deleteStrategy

deleteStrategy: RelationDeleteStrategy = null

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

Inherited from

SingleModelRelation.deleteStrategy


enabled

enabled: boolean = true

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

Inherited from

SingleModelRelation.enabled


foreignKeyName

foreignKeyName: string

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

Inherited from

SingleModelRelation.foreignKeyName


localKeyName

localKeyName: string

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

Inherited from

SingleModelRelation.localKeyName


name

name: string

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

Inherited from

SingleModelRelation.name


parent

parent: Parent

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

Inherited from

SingleModelRelation.parent


relatedClass

relatedClass: RelatedClass

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

Inherited from

SingleModelRelation.relatedClass


inverseBelongsToRelationClasses

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

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

Inherited from

SingleModelRelation.inverseBelongsToRelationClasses


inverseHasRelationClasses

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

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

Inherited from

SingleModelRelation.inverseHasRelationClasses

Accessors

loaded

Get Signature

get loaded(): boolean

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

Returns

boolean

Inherited from

SingleModelRelation.loaded


Get Signature

get related(): undefined | null | Related

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

Returns

undefined | null | Related

Set Signature

set related(related): void

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

Parameters

undefined | null | Related

Returns

void

Inherited from

SingleModelRelation.related

Methods

addRelated()

addRelated(related): void

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

Parameters

Related

Returns

void

Inherited from

SingleModelRelation.addRelated


attach()

Call Signature

attach(model?): Related

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

Parameters
model?

Related

Returns

Related

Inherited from

SingleModelRelation.attach

Call Signature

attach(attributes): Related

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

Parameters
attributes

Attributes

Returns

Related

Inherited from

SingleModelRelation.attach


clearForeignAttributes()

clearForeignAttributes(related): void

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

Parameters

Related

Returns

void

Overrides

SingleModelRelation.clearForeignAttributes


clearInverseRelations()

clearInverseRelations(model): void

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

Parameters

model

Related

Returns

void

Inherited from

SingleModelRelation.clearInverseRelations


clone()

clone(options): this

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

Parameters

options

Partial = {}

Returns

this

Inherited from

SingleModelRelation.clone


disable()

disable(): void

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

Returns

void

Inherited from

SingleModelRelation.disable


enable()

enable(): void

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

Returns

void

Inherited from

SingleModelRelation.enable


getLoadedModels()

getLoadedModels(): Related[]

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

Returns

Related[]

Inherited from

SingleModelRelation.getLoadedModels


getModels()

getModels(): Promise<Related[]>

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

Returns

Promise<Related[]>

Inherited from

SingleModelRelation.getModels


initializeInverseRelations()

initializeInverseRelations(model): void

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

Parameters

model

Related

Returns

void

Inherited from

SingleModelRelation.initializeInverseRelations


isEmpty()

isEmpty(): null | boolean

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

Returns

null | boolean

Inherited from

SingleModelRelation.isEmpty


isInverseOf()

isInverseOf(other): boolean

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

Parameters

other

Relation

Returns

boolean

Inherited from

SingleModelRelation.isInverseOf


isRelated()

isRelated(related): boolean

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

Parameters

Related

Returns

boolean

Inherited from

SingleModelRelation.isRelated


load()

load(): Promise<null | Related>

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

Returns

Promise<null | Related>

Overrides

SingleModelRelation.load


onDelete()

onDelete(strategy): this

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

Parameters

strategy

RelationDeleteStrategy

Returns

this

Inherited from

SingleModelRelation.onDelete


onRelatedUpdated()

protected onRelatedUpdated(oldValue, newValue): void

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

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

Parameters

Related

Returns

void

Inherited from

SingleModelRelation.removeRelated


resolve()

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

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

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

Parameters

Related

Returns

void

Overrides

SingleModelRelation.setForeignAttributes


static()

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

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

Returns

RelationConstructor<HasOneRelation<Parent, Related, RelatedClass>>

Inherited from

SingleModelRelation.static


unload()

unload(): void

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

Returns

void

Inherited from

SingleModelRelation.unload