Interface: SolidMultiModelDocumentRelation<Parent, Related, RelatedClass>

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

Extends

• SolidDocumentRelation<Related>

Extended by

• SolidBelongsToManyRelation
• SolidHasManyRelation

Type Parameters

Parent

Parent extends SolidModel = SolidModel

Related

Related extends SolidModel = SolidModel

RelatedClass

RelatedClass extends SolidModelConstructor<Related> = SolidModelConstructor<Related>

Properties

__modelsInOtherDocumentIds?

optional __modelsInOtherDocumentIds?: string[]

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

---

__modelsInSameDocument?

optional __modelsInSameDocument?: Related[]

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

---

__removedDocumentModels

__removedDocumentModels: Related[] = []

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

---

documentModelsLoaded

protected documentModelsLoaded: boolean = false

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

Inherited from

SolidDocumentRelation.documentModelsLoaded

---

useSameDocument

useSameDocument: boolean = false

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

Inherited from

SolidDocumentRelation.useSameDocument

Accessors

__newModels

Get Signature

get __newModels(): Related[]

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

Returns

Related[]

Set Signature

set __newModels(value): void

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

Parameters

value

Related[]

Returns

void

---

protectedSolidMulti

Get Signature

get protected protectedSolidMulti(): ProtectedSolidMultiRelation

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

Returns

ProtectedSolidMultiRelation

Methods

__afterParentSave()

__afterParentSave(): void

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

Returns

void

---

addRelated()

addRelated(this, related): void

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

Parameters

this

SolidMultiModelDocumentRelationThis

related

Related

Returns

void

---

cloneSolidData()

protected cloneSolidData(clone): void

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

Parameters

clone

SolidMultiModelDocumentRelationThis<Parent, Related, RelatedClass>

Returns

void

---

create()

create(this, attributes?): Promise<Related>

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

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

Parameters

this

SolidMultiModelDocumentRelationThis<Parent, Related, RelatedClass>

attributes?

Attributes = {}

Attributes to create the related instance.

Returns

Promise<Related>

---

detach()

detach(this, keyOrModel): void

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

Parameters

this

SolidMultiModelDocumentRelationThis<Parent, Related, RelatedClass>

keyOrModel

string | Related

Returns

void

---

isEmpty()

isEmpty(this): boolean | null

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

Parameters

this

SolidMultiModelDocumentRelationThis

Returns

boolean | null

---

isRelated()

isRelated(model): boolean

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

Parameters

model

Related

Returns

boolean

---

loadDocumentModels()

protected loadDocumentModels(this, modelsInSameDocument, modelsInOtherDocumentIds): void

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

Parameters

this

SolidMultiModelDocumentRelationThis<Parent, Related, RelatedClass>

modelsInSameDocument

Related[]

modelsInOtherDocumentIds

string[]

Returns

void

Overrides

SolidDocumentRelation.loadDocumentModels

---

remove()

remove(this, keyOrModel): Promise<void>

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

Parameters

this

SolidMultiModelDocumentRelationThis<Parent, Related, RelatedClass>

keyOrModel

string | Related

Returns

Promise<void>

---

save()

save(this, model): Promise<Related>

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

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

Related

Related model instance to save.

Returns

Promise<Related>

---

usingSameDocument()

usingSameDocument(useSameDocument?): this

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

Parameters

useSameDocument?

boolean = true

Returns

this

Inherited from

SolidDocumentRelation.usingSameDocument