Class: SolidContainerDocumentsRelation

Defined in: packages/soukai-solid/src/models/relations/SolidContainerDocumentsRelation.ts:25

Extends

• SolidBelongsToManyRelation<SolidContainer, SolidDocument, typeof SolidDocument>

Constructors

Constructor

new SolidContainerDocumentsRelation(container): SolidContainerDocumentsRelation

Defined in: packages/soukai-solid/src/models/relations/SolidContainerDocumentsRelation.ts:31

Parameters

container

SolidContainer

Returns

SolidContainerDocumentsRelation

Overrides

SolidBelongsToManyRelation.constructor

Properties

__modelsInOtherDocumentIds?

optional __modelsInOtherDocumentIds: string[]

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:40

Inherited from

SolidBelongsToManyRelation.__modelsInOtherDocumentIds

---

__modelsInSameDocument?

optional __modelsInSameDocument: SolidDocument[]

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:39

Inherited from

SolidBelongsToManyRelation.__modelsInSameDocument

---

__removedDocumentModels

__removedDocumentModels: SolidDocument[] = []

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:38

Inherited from

SolidBelongsToManyRelation.__removedDocumentModels

---

_related?

protected optional _related: null | SolidDocument | SolidDocument[]

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

Inherited from

SolidBelongsToManyRelation._related

---

deleteStrategy

deleteStrategy: RelationDeleteStrategy = null

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

Inherited from

SolidBelongsToManyRelation.deleteStrategy

---

documentModelsLoaded

protected documentModelsLoaded: boolean = false

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:23

Inherited from

SolidBelongsToManyRelation.documentModelsLoaded

---

enabled

enabled: boolean = true

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

Inherited from

SolidBelongsToManyRelation.enabled

---

foreignKeyName

foreignKeyName: string

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

Inherited from

SolidBelongsToManyRelation.foreignKeyName

---

localKeyName

localKeyName: string

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

Inherited from

SolidBelongsToManyRelation.localKeyName

---

name

name: string

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

Inherited from

SolidBelongsToManyRelation.name

---

parent

parent: SolidContainer

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

Inherited from

SolidBelongsToManyRelation.parent

---

relatedClass

relatedClass: typeof SolidDocument

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

Inherited from

SolidBelongsToManyRelation.relatedClass

---

useSameDocument

useSameDocument: boolean = false

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:21

Inherited from

SolidBelongsToManyRelation.useSameDocument

---

inverseBelongsToRelationClasses

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

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

Inherited from

SolidBelongsToManyRelation.inverseBelongsToRelationClasses

---

inverseHasRelationClasses

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

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

Inherited from

SolidBelongsToManyRelation.inverseHasRelationClasses

Accessors

__newModels

Get Signature

get __newModels(): Related[]

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:55

Returns

Related[]

Set Signature

set __newModels(value): void

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:59

Parameters

value

Related[]

Returns

void

Inherited from

SolidBelongsToManyRelation.__newModels

---

container

Get Signature

get container(): SolidContainer

Defined in: packages/soukai-solid/src/models/relations/SolidContainerDocumentsRelation.ts:35

Returns

SolidContainer

---

loaded

Get Signature

get loaded(): boolean

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

Returns

boolean

Inherited from

SolidBelongsToManyRelation.loaded

---

protectedSolidBelongsTo

Get Signature

get protected protectedSolidBelongsTo(): ProtectedSolidBelongsToRelation

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidBelongsToRelation.ts:26

Returns

ProtectedSolidBelongsToRelation

Inherited from

SolidBelongsToManyRelation.protectedSolidBelongsTo

---

protectedSolidMulti

Get Signature

get protected protectedSolidMulti(): ProtectedSolidMultiRelation

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:43

Returns

ProtectedSolidMultiRelation

Inherited from

SolidBelongsToManyRelation.protectedSolidMulti

---

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

SolidBelongsToManyRelation.related

Methods

__afterParentSave()

__afterParentSave(): void

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:169

Returns

void

Inherited from

SolidBelongsToManyRelation.__afterParentSave

---

__beforeParentCreate()

__beforeParentCreate(): void

Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToManyRelation.ts:123

Returns

void

Inherited from

SolidBelongsToManyRelation.__beforeParentCreate

---

__loadDocumentModels()

__loadDocumentModels(documentUrl, document): Promise<void>

Defined in: packages/soukai-solid/src/models/relations/SolidContainerDocumentsRelation.ts:65

Parameters

documentUrl

string

document

JsonLDGraph

Returns

Promise<void>

Overrides

SolidBelongsToManyRelation.__loadDocumentModels

---

__synchronizeRelated()

__synchronizeRelated(other, models): Promise<void>

Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToManyRelation.ts:140

Parameters

other

this

models

WeakSet<SolidModel>

Returns

Promise<void>

Inherited from

SolidBelongsToManyRelation.__synchronizeRelated

---

addRelated()

addRelated(related): void

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

Parameters

related

SolidDocument

Returns

void

Inherited from

SolidBelongsToManyRelation.addRelated

---

assertLoaded()

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

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

Parameters

method

string

Returns

this is { related: SolidDocument[] }

Inherited from

SolidBelongsToManyRelation.assertLoaded

---

associate()

associate(foreignKey): void

Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToManyRelation.ts:83

Parameters

foreignKey

unknown

Returns

void

Inherited from

SolidBelongsToManyRelation.associate

---

attach()

Call Signature

attach(model?): SolidDocument

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

Parameters

model?

SolidDocument

Returns

SolidDocument

Inherited from

SolidBelongsToManyRelation.attach

Call Signature

attach(attributes): SolidDocument

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

Parameters

attributes

Attributes

Returns

SolidDocument

Inherited from

SolidBelongsToManyRelation.attach

---

clearForeignAttributes()

clearForeignAttributes(related): void

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

Parameters

related

SolidDocument

Returns

void

Inherited from

SolidBelongsToManyRelation.clearForeignAttributes

---

clearInverseRelations()

clearInverseRelations(model): void

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

Parameters

model

SolidDocument

Returns

void

Inherited from

SolidBelongsToManyRelation.clearInverseRelations

---

clone()

clone(options): this

Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToManyRelation.ts:117

Parameters

options

Partial = {}

Returns

this

Inherited from

SolidBelongsToManyRelation.clone

---

cloneSolidData()

protected cloneSolidData(clone): void

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:173

Parameters

clone

SolidMultiModelDocumentRelationThis<SolidContainer, SolidDocument, typeof SolidDocument>

Returns

void

Inherited from

SolidBelongsToManyRelation.cloneSolidData

---

create()

create(attributes): Promise<SolidDocument>

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

This method will create an instance of the related model and call the [[save]] method.

Parameters

attributes

Attributes = {}

Returns

Promise<SolidDocument>

Inherited from

SolidBelongsToManyRelation.create

---

detach()

detach(this, keyOrModel): void

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:122

Parameters

this

SolidMultiModelDocumentRelationThis<SolidContainer, SolidDocument, typeof SolidDocument>

keyOrModel

string | SolidDocument

Returns

void

Inherited from

SolidBelongsToManyRelation.detach

---

disable()

disable(): void

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

Returns

void

Inherited from

SolidBelongsToManyRelation.disable

---

disassociate()

disassociate(foreignKey): void

Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToManyRelation.ts:90

Parameters

foreignKey

unknown

Returns

void

Inherited from

SolidBelongsToManyRelation.disassociate

---

enable()

enable(): void

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

Returns

void

Inherited from

SolidBelongsToManyRelation.enable

---

getLoadedModels()

getLoadedModels(): SolidDocument[]

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

Returns

SolidDocument[]

Inherited from

SolidBelongsToManyRelation.getLoadedModels

---

getModels()

getModels(): Promise<SolidDocument[]>

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

Returns

Promise<SolidDocument[]>

Inherited from

SolidBelongsToManyRelation.getModels

---

initializeInverseRelations()

initializeInverseRelations(model): void

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

Parameters

model

SolidDocument

Returns

void

Inherited from

SolidBelongsToManyRelation.initializeInverseRelations

---

isEmpty()

isEmpty(): null | boolean

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

Returns

null | boolean

Inherited from

SolidBelongsToManyRelation.isEmpty

---

isInverseOf()

isInverseOf(other): boolean

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

Parameters

other

Relation

Returns

boolean

Inherited from

SolidBelongsToManyRelation.isInverseOf

---

isRelated()

isRelated(model): boolean

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

Parameters

model

SolidDocument

Returns

boolean

Inherited from

SolidBelongsToManyRelation.isRelated

---

load()

load(): Promise<SolidDocument[]>

Defined in: packages/soukai-solid/src/models/relations/SolidContainerDocumentsRelation.ts:39

Returns

Promise<SolidDocument[]>

Overrides

SolidBelongsToManyRelation.load

---

loadDocumentModels()

protected loadDocumentModels(this, modelsInSameDocument, modelsInOtherDocumentIds): void

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:206

Parameters

this

SolidMultiModelDocumentRelationThis<SolidContainer, SolidDocument, typeof SolidDocument>

modelsInSameDocument

SolidDocument[]

modelsInOtherDocumentIds

string[]

Returns

void

Inherited from

SolidBelongsToManyRelation.loadDocumentModels

---

onDelete()

onDelete(strategy): this

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

Parameters

strategy

RelationDeleteStrategy

Returns

this

Inherited from

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

SolidBelongsToManyRelation.onRelatedUpdated

---

remove()

remove(this, keyOrModel): Promise<void>

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:116

Parameters

this

SolidMultiModelDocumentRelationThis<SolidContainer, SolidDocument, typeof SolidDocument>

keyOrModel

string | SolidDocument

Returns

Promise<void>

Inherited from

SolidBelongsToManyRelation.remove

---

removeRelated()

removeRelated(related): void

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

Parameters

related

SolidDocument

Returns

void

Inherited from

SolidBelongsToManyRelation.removeRelated

---

reset()

reset(related): void

Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToManyRelation.ts:100

Parameters

related

SolidDocument[] = []

Returns

void

Inherited from

SolidBelongsToManyRelation.reset

---

resolve()

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

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

Returns

Promise<null | SolidDocument | SolidDocument[]>

Deprecated

This method has been renamed to load.

Inherited from

SolidBelongsToManyRelation.resolve

---

save()

save(this, model): Promise<SolidDocument>

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:101

This method will bind up all the relevant data (foreignKey, inverse relations, etc.) and save the model. If the parent model does not exist and both models will be stored in the same document, the model will be saved when the parent model is saved instead.

Parameters

this

SolidMultiModelDocumentRelationThis

model

SolidDocument

Related model instance to save.

Returns

Promise<SolidDocument>

Inherited from

SolidBelongsToManyRelation.save

---

setForeignAttributes()

setForeignAttributes(related): void

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

Parameters

related

SolidDocument

Returns

void

Inherited from

SolidBelongsToManyRelation.setForeignAttributes

---

static()

static(): RelationConstructor<SolidContainerDocumentsRelation>

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

Returns

RelationConstructor<SolidContainerDocumentsRelation>

Inherited from

SolidBelongsToManyRelation.static

---

unload()

unload(): void

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

Returns

void

Inherited from

SolidBelongsToManyRelation.unload

---

usingSameDocument()

usingSameDocument(useSameDocument): this

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:25

Parameters

useSameDocument

boolean = true

Returns

this

Inherited from

SolidBelongsToManyRelation.usingSameDocument