Soukai

Appearance

Interface: BeforeParentCreateRelation ​

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

Extends ​

Properties ​

deleteStrategy ​

deleteStrategy: RelationDeleteStrategy = null

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

Inherited from ​

Relation.deleteStrategy

enabled ​

enabled: boolean = true

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

Inherited from ​

Relation.enabled

foreignKeyName ​

foreignKeyName: string

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

Inherited from ​

Relation.foreignKeyName

localKeyName ​

localKeyName: string

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

Inherited from ​

Relation.localKeyName

name ​

name: string

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

Inherited from ​

Relation.name

parent ​

parent: Model

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

Inherited from ​

Relation.parent

optional related: null | Model | Model[]

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

Inherited from ​

Relation.related

relatedClass ​

relatedClass: ModelConstructor

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

Inherited from ​

Relation.relatedClass

Accessors ​

loaded ​

Get Signature ​

get loaded(): boolean

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

Returns ​

boolean

Inherited from ​

Relation.loaded

Methods ​

__beforeParentCreate() ​

__beforeParentCreate(): void

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

Returns ​

void

addRelated() ​

abstract addRelated(related): void

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

Parameters ​

Model

Returns ​

void

Inherited from ​

Relation.addRelated

clone() ​

clone(options): this

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

Parameters ​

options ​

Partial = {}

Returns ​

this

Inherited from ​

Relation.clone

disable() ​

disable(): void

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

Returns ​

void

Inherited from ​

Relation.disable

enable() ​

enable(): void

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

Returns ​

void

Inherited from ​

Relation.enable

getLoadedModels() ​

getLoadedModels(): Model[]

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

Returns ​

Model[]

Inherited from ​

Relation.getLoadedModels

getModels() ​

getModels(): Promise<Model[]>

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

Returns ​

Promise<Model[]>

Inherited from ​

Relation.getModels

initializeInverseRelations() ​

initializeInverseRelations(model): void

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

Parameters ​

model ​

Model

Returns ​

void

Inherited from ​

Relation.initializeInverseRelations

isEmpty() ​

isEmpty(): null | boolean

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

Returns ​

null | boolean

Inherited from ​

Relation.isEmpty

isInverseOf() ​

isInverseOf(relation): boolean

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

Parameters ​

relation ​

Relation

Returns ​

boolean

Inherited from ​

Relation.isInverseOf

isRelated() ​

abstract isRelated(model): boolean

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

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

Returns ​

Promise<null | Model | Model[]>

Inherited from ​

Relation.load

onDelete() ​

onDelete(strategy): this

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

Parameters ​

strategy ​

RelationDeleteStrategy

Returns ​

this

Inherited from ​

Relation.onDelete

resolve() ​

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

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

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

Parameters ​

Model

Returns ​

void

Inherited from ​

Relation.setForeignAttributes

static() ​

static(): RelationConstructor<BeforeParentCreateRelation>

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

Returns ​

RelationConstructor<BeforeParentCreateRelation>

Inherited from ​

Relation.static

unload() ​

unload(): void

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

Returns ​

void

Inherited from ​

Relation.unload