Soukai

Appearance

Interface: SolidSingleModelDocumentRelation<Parent, Related, RelatedClass> ​

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

Extends ​

Extended by ​

Type Parameters ​

Parent ​

Parent extends SolidModel = SolidModel

Related extends SolidModel = SolidModel

RelatedClass ​

RelatedClass extends SolidModelConstructor<Related> = SolidModelConstructor<Related>

Properties ​

__modelInOtherDocumentId? ​

optional __modelInOtherDocumentId?: string

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:32

__modelInSameDocument? ​

optional __modelInSameDocument?: Related

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

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 ​

__newModel ​

Get Signature ​

get __newModel(): Related | undefined

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

Returns ​

Related | undefined

Set Signature ​

set __newModel(value): void

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:47

Parameters ​
value ​

Related | undefined

Returns ​

void

Methods ​

__synchronizeRelated() ​

protected __synchronizeRelated(this, other, options): Promise<void>

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

Parameters ​

this ​

SolidSingleModelDocumentRelationThis<Parent, Related, RelatedClass>

other ​

SolidSingleModelDocumentRelationThis<Parent, Related, RelatedClass>

options ​

object & SynchronizeCloneOptions

Returns ​

Promise<void>

addRelated() ​

addRelated(this, related): void

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:96

Parameters ​

this ​

SolidSingleModelDocumentRelationThis

Related

Returns ​

void

cloneSolidData() ​

protected cloneSolidData(this, clone): void

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:112

Parameters ​

this ​

SolidSingleModelDocumentRelationThis<Parent, Related, RelatedClass>

clone ​

SolidSingleModelDocumentRelationThis<Parent, Related, RelatedClass>

Returns ​

void

create() ​

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

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:66

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

Parameters ​

this ​

SolidSingleModelDocumentRelationThis<Parent, Related, RelatedClass>

attributes? ​

Attributes = {}

Attributes to create the related instance.

Returns ​

Promise<Related>

isEmpty() ​

isEmpty(this): boolean | null

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

Parameters ​

this ​

SolidSingleModelDocumentRelationThis

Returns ​

boolean | null

isRelated() ​

isRelated(related): boolean

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:108

Parameters ​

Related

Returns ​

boolean

loadDocumentModels() ​

protected loadDocumentModels(this, modelsInSameDocument, modelsInOtherDocumentIds): void

Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:134

Parameters ​

this ​

SolidSingleModelDocumentRelationThis<Parent, Related, RelatedClass>

modelsInSameDocument ​

Related[]

modelsInOtherDocumentIds ​

string[]

Returns ​

void

Overrides ​

SolidDocumentRelation.loadDocumentModels

save() ​

save(this, model): Promise<Related>

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

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 ​

SolidSingleModelDocumentRelationThis

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