Class: SolidSingleModelDocumentRelation<Parent, Related, RelatedClass>
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:27
Extends
SolidDocumentRelation
<Related
>
Extended by
Type Parameters
Parent
Parent
extends SolidModel
= SolidModel
Related
Related
extends SolidModel
= SolidModel
RelatedClass
RelatedClass
extends SolidModelConstructor
<Related
> = SolidModelConstructor
<Related
>
Constructors
Constructor
new SolidSingleModelDocumentRelation<
Parent
,Related
,RelatedClass
>():SolidSingleModelDocumentRelation
<Parent
,Related
,RelatedClass
>
Returns
SolidSingleModelDocumentRelation
<Parent
, Related
, RelatedClass
>
Inherited from
SolidDocumentRelation
.constructor
Properties
__modelInOtherDocumentId?
optional
__modelInOtherDocumentId:string
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:34
__modelInSameDocument?
optional
__modelInSameDocument:Related
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:33
documentModelsLoaded
protected
documentModelsLoaded:boolean
=false
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:23
Inherited from
SolidDocumentRelation
.documentModelsLoaded
useSameDocument
useSameDocument:
boolean
=false
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:21
Inherited from
SolidDocumentRelation
.useSameDocument
Accessors
__newModel
Get Signature
get __newModel():
undefined
|Related
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:45
Returns
undefined
| Related
Set Signature
set __newModel(
value
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:49
Parameters
value
undefined
| Related
Returns
void
Methods
addRelated()
addRelated(
this
,related
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:98
Parameters
this
SolidSingleModelDocumentRelationThis
related
Related
Returns
void
cloneSolidData()
protected
cloneSolidData(this
,clone
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:114
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:68
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
):null
|boolean
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:57
Parameters
this
SolidSingleModelDocumentRelationThis
Returns
null
| boolean
isRelated()
isRelated(
related
):boolean
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:110
Parameters
related
Related
Returns
boolean
loadDocumentModels()
protected
loadDocumentModels(this
,modelsInSameDocument
,modelsInOtherDocumentIds
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:136
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:85
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
>
synchronizeRelated()
protected
synchronizeRelated(this
,other
,models
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:175
Parameters
this
SolidSingleModelDocumentRelationThis
<Parent
, Related
, RelatedClass
>
other
SolidSingleModelDocumentRelationThis
<Parent
, Related
, RelatedClass
>
models
WeakSet
<SolidModel
>
Returns
Promise
<void
>
usingSameDocument()
usingSameDocument(
useSameDocument
):this
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:25
Parameters
useSameDocument
boolean
= true
Returns
this