Class: BelongsToManyRelation<Parent, Related, RelatedClass>

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

Extends

• MultiModelRelation<Parent, Related, RelatedClass>

Extended by

• SolidContainsRelation

Type Parameters

Parent

Parent extends Model = Model

Related

Related extends Model = Model

RelatedClass

RelatedClass extends ModelConstructor<Related> = ModelConstructor<Related>

Constructors

Constructor

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

Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:16

Parameters

parent

Parent

relatedClass

RelatedClass

foreignKeyName?

string

localKeyName?

string

Returns

BelongsToManyRelation<Parent, Related, RelatedClass>

Inherited from

MultiModelRelation.constructor

Properties

_related?

protected optional _related: null | Related | Related[]

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

Inherited from

MultiModelRelation._related

---

deleteStrategy

deleteStrategy: RelationDeleteStrategy = null

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

Inherited from

MultiModelRelation.deleteStrategy

---

enabled

enabled: boolean = true

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

Inherited from

MultiModelRelation.enabled

---

foreignKeyName

foreignKeyName: string

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

Inherited from

MultiModelRelation.foreignKeyName

---

localKeyName

localKeyName: string

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

Inherited from

MultiModelRelation.localKeyName

---

name

name: string

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

Inherited from

MultiModelRelation.name

---

parent

parent: Parent

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

Inherited from

MultiModelRelation.parent

---

relatedClass

relatedClass: RelatedClass

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

Inherited from

MultiModelRelation.relatedClass

---

inverseBelongsToRelationClasses

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

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

Inherited from

MultiModelRelation.inverseBelongsToRelationClasses

---

inverseHasRelationClasses

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

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

Inherited from

MultiModelRelation.inverseHasRelationClasses

Accessors

loaded

Get Signature

get loaded(): boolean

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

Returns

boolean

Inherited from

MultiModelRelation.loaded

---

related

Get Signature

get related(): undefined | Related[]

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

Returns

undefined | Related[]

Set Signature

set related(related): void

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

Parameters

related

undefined | Related[]

Returns

void

Inherited from

MultiModelRelation.related

Methods

addRelated()

addRelated(related): void

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

Parameters

related

Related

Returns

void

Inherited from

MultiModelRelation.addRelated

---

assertLoaded()

protected assertLoaded(method): this is { related: Related[] }

Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:90

Parameters

method

string

Returns

this is { related: Related[] }

Inherited from

MultiModelRelation.assertLoaded

---

attach()

Call Signature

attach(model?): Related

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

Parameters

model?

Related

Returns

Related

Inherited from

MultiModelRelation.attach

Call Signature

attach(attributes): Related

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

Parameters

attributes

Attributes

Returns

Related

Inherited from

MultiModelRelation.attach

---

clearForeignAttributes()

clearForeignAttributes(related): void

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

Parameters

related

Related

Returns

void

Overrides

MultiModelRelation.clearForeignAttributes

---

clearInverseRelations()

clearInverseRelations(model): void

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

Parameters

model

Related

Returns

void

Inherited from

MultiModelRelation.clearInverseRelations

---

clone()

clone(options): this

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

Parameters

options

Partial = {}

Returns

this

Inherited from

MultiModelRelation.clone

---

create()

create(attributes): Promise<Related>

Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:55

Parameters

attributes

Attributes = {}

Returns

Promise<Related>

Inherited from

MultiModelRelation.create

---

disable()

disable(): void

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

Returns

void

Inherited from

MultiModelRelation.disable

---

enable()

enable(): void

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

Returns

void

Inherited from

MultiModelRelation.enable

---

getLoadedModels()

getLoadedModels(): Related[]

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

Returns

Related[]

Inherited from

MultiModelRelation.getLoadedModels

---

getModels()

getModels(): Promise<Related[]>

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

Returns

Promise<Related[]>

Inherited from

MultiModelRelation.getModels

---

initializeInverseRelations()

initializeInverseRelations(model): void

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

Parameters

model

Related

Returns

void

Inherited from

MultiModelRelation.initializeInverseRelations

---

isEmpty()

isEmpty(): null | boolean

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

Returns

null | boolean

Overrides

MultiModelRelation.isEmpty

---

isInverseOf()

isInverseOf(other): boolean

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

Parameters

other

Relation

Returns

boolean

Inherited from

MultiModelRelation.isInverseOf

---

isRelated()

isRelated(model): boolean

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

Parameters

model

Related

Returns

boolean

Inherited from

MultiModelRelation.isRelated

---

load()

load(): Promise<Related[]>

Defined in: packages/soukai/src/models/relations/BelongsToManyRelation.ts:16

Returns

Promise<Related[]>

Overrides

MultiModelRelation.load

---

onDelete()

onDelete(strategy): this

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

Parameters

strategy

RelationDeleteStrategy

Returns

this

Inherited from

MultiModelRelation.onDelete

---

onRelatedUpdated()

protected onRelatedUpdated(oldValue, newValue): void

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

Parameters

oldValue

Nullable<Model[]>

newValue

Nullable<Model[]>

Returns

void

Inherited from

MultiModelRelation.onRelatedUpdated

---

removeRelated()

removeRelated(related): void

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

Parameters

related

Related

Returns

void

Inherited from

MultiModelRelation.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

MultiModelRelation.resolve

---

setForeignAttributes()

setForeignAttributes(related): void

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

Parameters

related

Related

Returns

void

Overrides

MultiModelRelation.setForeignAttributes

---

static()

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

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

Returns

RelationConstructor<BelongsToManyRelation<Parent, Related, RelatedClass>>

Inherited from

MultiModelRelation.static

---

unload()

unload(): void

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

Returns

void

Inherited from

MultiModelRelation.unload