Interface: BeforeParentCreateRelation

Defined in: packages/soukai-solid/src/models/relations/guards.ts:9

Extends

• Relation

Properties

_related?

protected optional _related: null | Model | Model[]

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

Inherited from

Relation._related

---

deleteStrategy

deleteStrategy: RelationDeleteStrategy = null

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

Inherited from

Relation.deleteStrategy

---

enabled

enabled: boolean = true

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

Inherited from

Relation.enabled

---

foreignKeyName

foreignKeyName: string

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

Inherited from

Relation.foreignKeyName

---

localKeyName

localKeyName: string

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

Inherited from

Relation.localKeyName

---

name

name: string

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

Inherited from

Relation.name

---

parent

parent: Model

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

Inherited from

Relation.parent

---

relatedClass

relatedClass: ModelConstructor

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

Inherited from

Relation.relatedClass

Accessors

loaded

Get Signature

get loaded(): boolean

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

Returns

boolean

Inherited from

Relation.loaded

---

related

Get Signature

get related(): Nullable<Related | Related[]>

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

Returns

Nullable<Related | Related[]>

Set Signature

set related(related): void

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

Parameters

related

Nullable<Related | Related[]>

Returns

void

Inherited from

Relation.related

Methods

__beforeParentCreate()

__beforeParentCreate(): void

Defined in: packages/soukai-solid/src/models/relations/guards.ts:10

Returns

void

---

addRelated()

abstract addRelated(related): void

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

Parameters

related

Model

Returns

void

Inherited from

Relation.addRelated

---

clearForeignAttributes()

abstract clearForeignAttributes(related): void

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

Parameters

related

Model

Returns

void

Inherited from

Relation.clearForeignAttributes

---

clearInverseRelations()

clearInverseRelations(model): void

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

Parameters

model

Model

Returns

void

Inherited from

Relation.clearInverseRelations

---

clone()

clone(options): this

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

Parameters

options

Partial = {}

Returns

this

Inherited from

Relation.clone

---

disable()

disable(): void

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

Returns

void

Inherited from

Relation.disable

---

enable()

enable(): void

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

Returns

void

Inherited from

Relation.enable

---

getLoadedModels()

getLoadedModels(): Model[]

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

Returns

Model[]

Inherited from

Relation.getLoadedModels

---

getModels()

getModels(): Promise<Model[]>

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

Returns

Promise<Model[]>

Inherited from

Relation.getModels

---

initializeInverseRelations()

initializeInverseRelations(model): void

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

Parameters

model

Model

Returns

void

Inherited from

Relation.initializeInverseRelations

---

isEmpty()

isEmpty(): null | boolean

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

Returns

null | boolean

Inherited from

Relation.isEmpty

---

isInverseOf()

isInverseOf(other): boolean

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

Parameters

other

Relation

Returns

boolean

Inherited from

Relation.isInverseOf

---

isRelated()

abstract isRelated(model): boolean

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

Parameters

model

Model

Returns

boolean

Inherited from

Relation.isRelated

---

load()

abstract load(): Promise<null | Model | Model[]>

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

Returns

Promise<null | Model | Model[]>

Inherited from

Relation.load

---

onDelete()

onDelete(strategy): this

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

Parameters

strategy

RelationDeleteStrategy

Returns

this

Inherited from

Relation.onDelete

---

onRelatedUpdated()

protected onRelatedUpdated(oldValue, newValue): void

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

Parameters

oldValue

Nullable<Model | Model[]>

newValue

Nullable<Model | Model[]>

Returns

void

Inherited from

Relation.onRelatedUpdated

---

removeRelated()

abstract removeRelated(related): void

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

Parameters

related

Model

Returns

void

Inherited from

Relation.removeRelated

---

resolve()

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

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

Returns

Promise<null | Model | Model[]>

Deprecated

This method has been renamed to load.

Inherited from

Relation.resolve

---

setForeignAttributes()

abstract setForeignAttributes(related): void

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

Parameters

related

Model

Returns

void

Inherited from

Relation.setForeignAttributes

---

static()

static(): RelationConstructor<BeforeParentCreateRelation>

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

Returns

RelationConstructor<BeforeParentCreateRelation>

Inherited from

Relation.static

---

unload()

unload(): void

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

Returns

void

Inherited from

Relation.unload