Class: SolidModel
Defined in: packages/soukai-solid/src/models/SolidModel.ts:131
Extends
Constructors
Constructor
new SolidModel(
attributes
,exists
):SolidModel
Defined in: packages/soukai/src/models/Model.ts:487
Parameters
attributes
Attributes
= {}
exists
boolean
= false
Returns
SolidModel
Inherited from
SolidModelBase.constructor
Properties
_attributes
protected
_attributes:Attributes
Defined in: packages/soukai/src/models/Model.ts:478
Inherited from
SolidModelBase._attributes
_dirtyAttributes
protected
_dirtyAttributes:Attributes
Defined in: packages/soukai/src/models/Model.ts:480
Inherited from
SolidModelBase._dirtyAttributes
_documentExists
protected
_documentExists:boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:713
_exists
protected
_exists:boolean
Defined in: packages/soukai/src/models/Model.ts:475
Inherited from
SolidModelBase._exists
_malformedDocumentAttributes
protected
_malformedDocumentAttributes:Record
<string
,string
[]>
Defined in: packages/soukai/src/models/Model.ts:481
Inherited from
SolidModelBase._malformedDocumentAttributes
_originalAttributes
protected
_originalAttributes:Attributes
Defined in: packages/soukai/src/models/Model.ts:479
Inherited from
SolidModelBase._originalAttributes
_proxy
protected
_proxy:SolidModel
Defined in: packages/soukai/src/models/Model.ts:477
Inherited from
SolidModelBase._proxy
_publicPermissions
protected
_publicPermissions:undefined
|SolidDocumentPermission
[]
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:18
Inherited from
SolidModelBase._publicPermissions
_relations
protected
_relations:Record
<string
,SolidRelation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:718
Overrides
SolidModelBase._relations
_removedResourceUrls
protected
_removedResourceUrls:string
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:716
_sourceDocumentUrl
protected
_sourceDocumentUrl:null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:714
_trackedDirtyAttributes
protected
_trackedDirtyAttributes:Attributes
Defined in: packages/soukai-solid/src/models/SolidModel.ts:715
_usesRdfAliases
protected
_usesRdfAliases:boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:717
_wasRecentlyCreated
protected
_wasRecentlyCreated:boolean
Defined in: packages/soukai/src/models/Model.ts:476
Inherited from
SolidModelBase._wasRecentlyCreated
authorizations?
optional
authorizations:SolidACLAuthorization
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:704
deletedAt?
optional
deletedAt:Date
Defined in: packages/soukai-solid/src/models/SolidModel.ts:703
id
id:
string
Defined in: packages/soukai/src/models/Model.ts:474
Inherited from
SolidModelBase.id
metadata
metadata:
Metadata
Defined in: packages/soukai-solid/src/models/SolidModel.ts:705
operations
operations:
Operation
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:706
relatedAuthorizations
relatedAuthorizations:
SolidACLAuthorizationsRelation
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:708
relatedMetadata
relatedMetadata:
SolidHasOneRelation
<SolidModel
,Metadata
,SolidModelConstructor
<Metadata
>>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:709
relatedOperations
relatedOperations:
OperationsRelation
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:710
relatedTombstone
relatedTombstone:
TombstoneRelation
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:711
tombstone?
optional
tombstone:Tombstone
Defined in: packages/soukai-solid/src/models/SolidModel.ts:707
url
url:
string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:701
__attributeGetters
static
__attributeGetters:Map
<string
, () =>unknown
>
Defined in: packages/soukai/src/models/Model.ts:67
Inherited from
SolidModelBase.__attributeGetters
__attributeSetters
static
__attributeSetters:Map
<string
, (value
) =>void
>
Defined in: packages/soukai/src/models/Model.ts:68
Inherited from
SolidModelBase.__attributeSetters
__isSchema?
static
optional
__isSchema:boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:147
classFields
static
classFields:string
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:135
Overrides
SolidModelBase.classFields
collection
static
collection:string
Defined in: packages/soukai/src/models/Model.ts:59
Inherited from
SolidModelBase.collection
defaultResourceHash
static
defaultResourceHash:null
|string
='it'
Defined in: packages/soukai-solid/src/models/SolidModel.ts:142
fields
static
fields:SolidFieldsDefinition
Defined in: packages/soukai-solid/src/models/SolidModel.ts:134
Overrides
SolidModelBase.fields
history
static
history:boolean
=false
Defined in: packages/soukai-solid/src/models/SolidModel.ts:145
historyDisabled
protected
static
historyDisabled:WeakMap
<SolidModel
,void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:150
hooks
static
hooks:Partial
={}
Defined in: packages/soukai/src/models/Model.ts:66
Inherited from
SolidModelBase.hooks
mintsUrls
static
mintsUrls:boolean
=true
Defined in: packages/soukai-solid/src/models/SolidModel.ts:144
modelName
static
modelName:string
Defined in: packages/soukai/src/models/Model.ts:63
Inherited from
SolidModelBase.modelName
primaryKey
static
primaryKey:string
='url'
Defined in: packages/soukai-solid/src/models/SolidModel.ts:133
Overrides
SolidModelBase.primaryKey
rdfContext?
static
optional
rdfContext:string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:136
rdfContexts
static
rdfContexts:RDFContexts
={}
Defined in: packages/soukai-solid/src/models/SolidModel.ts:137
rdfPropertyFields?
protected
static
optional
rdfPropertyFields:Record
<string
,string
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:149
rdfsClass?
static
optional
rdfsClass:string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:138
rdfsClasses
static
rdfsClasses:string
[] =[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:139
rdfsClassesAliases
static
rdfsClassesAliases:string
[][] =[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:140
relations
static
relations:string
[] =[]
Defined in: packages/soukai/src/models/Model.ts:65
Inherited from
SolidModelBase.relations
reservedRelations
static
reservedRelations:string
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:141
slugField?
static
optional
slugField:string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:143
softDeletesEnabled
protected
static
softDeletesEnabled:boolean
=false
Defined in: packages/soukai-solid/src/models/SolidModel.ts:151
timestamps
static
timestamps:TimestampsDefinition
Defined in: packages/soukai/src/models/Model.ts:61
Inherited from
SolidModelBase.timestamps
tombstone
static
tombstone:boolean
=true
Defined in: packages/soukai-solid/src/models/SolidModel.ts:146
Accessors
isPrivate
Get Signature
get isPrivate():
null
|boolean
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:24
Returns
null
| boolean
Inherited from
SolidModelBase.isPrivate
isPublic
Get Signature
get isPublic():
null
|boolean
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:20
Returns
null
| boolean
Inherited from
SolidModelBase.isPublic
Methods
addArrayHistoryOperations()
protected
addArrayHistoryOperations(this
,field
,dirtyValue
,originalValue
):void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:363
Parameters
this
field
string
dirtyValue
unknown
originalValue
unknown
Returns
void
Inherited from
SolidModelBase.addArrayHistoryOperations
addDirtyHistoryOperations()
protected
addDirtyHistoryOperations(this
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:237
Parameters
this
Returns
Promise
<void
>
Inherited from
SolidModelBase.addDirtyHistoryOperations
addHistoryOperations()
addHistoryOperations(
this
,operations
):void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:183
Parameters
this
operations
Returns
void
Inherited from
SolidModelBase.addHistoryOperations
afterSave()
protected
afterSave(ignoreRelations?
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1384
Parameters
ignoreRelations?
boolean
Returns
Promise
<void
>
Overrides
SolidModelBase.afterSave
attributeValueChanged()
protected
attributeValueChanged(originalValue
,newValue
):boolean
Defined in: packages/soukai/src/models/Model.ts:1297
Parameters
originalValue
unknown
newValue
unknown
Returns
boolean
Inherited from
SolidModelBase.attributeValueChanged
authorizationsRelationship()
authorizationsRelationship():
Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1167
Returns
beforeCreate()
protected
beforeCreate():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1315
Returns
Promise
<void
>
beforeDocumentSave()
protected
beforeDocumentSave():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1289
Returns
Promise
<void
>
beforeSave()
protected
beforeSave(ignoreRelations?
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1271
Parameters
ignoreRelations?
boolean
Returns
Promise
<void
>
Overrides
SolidModelBase.beforeSave
beforeUpdate()
protected
beforeUpdate():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1335
Returns
Promise
<void
>
belongsToMany()
Call Signature
protected
belongsToMany<T
>(relatedClass
,foreignKeyField?
,localKeyField?
):SolidBelongsToManyRelation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1554
Creates a relation when this model references multiple instances of another model.
Type Parameters
T
T
extends typeof SolidModel
Parameters
relatedClass
T
Related model class.
foreignKeyField?
string
Name of the foreign key field in the local model.
localKeyField?
string
Name of the local key field in the related model. Defaults to the primary key name defined in the related model class.
Returns
Overrides
SolidModelBase.belongsToMany
Call Signature
protected
belongsToMany<T
>(relatedClass
,foreignKeyField?
,localKeyField?
):Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1560
Type Parameters
T
T
extends typeof Model
Parameters
relatedClass
T
foreignKeyField?
string
localKeyField?
string
Returns
Overrides
SolidModelBase.belongsToMany
belongsToOne()
Call Signature
protected
belongsToOne<T
>(relatedClass
,foreignKeyField?
,localKeyField?
):SolidBelongsToOneRelation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1532
Creates a relation when this model references one instance of another model.
Type Parameters
T
T
extends typeof SolidModel
Parameters
relatedClass
T
Related model class.
foreignKeyField?
string
Name of the foreign key field in the local model.
localKeyField?
string
Name of the local key field in the related model. Defaults to the primary key name defined in the related model class.
Returns
Overrides
SolidModelBase.belongsToOne
Call Signature
protected
belongsToOne<T
>(relatedClass
,foreignKeyField?
,localKeyField?
):Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1538
Type Parameters
T
T
extends typeof Model
Parameters
relatedClass
T
foreignKeyField?
string
localKeyField?
string
Returns
Overrides
SolidModelBase.belongsToOne
callAttributeGetter()
callAttributeGetter(
field
):unknown
Defined in: packages/soukai/src/models/Model.ts:803
Parameters
field
string
Returns
unknown
Inherited from
SolidModelBase.callAttributeGetter
callAttributeSetter()
callAttributeSetter(
field
,value
):void
Defined in: packages/soukai/src/models/Model.ts:707
Parameters
field
string
value
unknown
Returns
void
Inherited from
SolidModelBase.callAttributeSetter
castAttribute()
protected
castAttribute(value
,options
):unknown
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1671
Parameters
value
unknown
options
ModelCastAttributeOptions
= {}
Returns
unknown
Overrides
SolidModelBase.castAttribute
castAttributes()
protected
castAttributes(attributes
,definitions
,malformedAttributes?
,fieldPrefix?
):Attributes
Defined in: packages/soukai/src/models/Model.ts:1307
Parameters
attributes
definitions
malformedAttributes?
Record
<string
, string
[]>
fieldPrefix?
string
= ''
Returns
Inherited from
SolidModelBase.castAttributes
cleanDirty()
cleanDirty(
ignoreRelations?
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:943
Parameters
ignoreRelations?
boolean
Returns
void
Overrides
SolidModelBase.cleanDirty
clone()
Call Signature
clone(
options?
):this
Defined in: packages/soukai/src/models/Model.ts:920
Parameters
options?
Partial
<{ clean
: boolean
; clones
: WeakMap
<Model
, Model
>; constructors
: WeakMap
<typeof Model
, typeof Model
> | [typeof Model
, typeof Model
][]; }>
Returns
this
Inherited from
SolidModelBase.clone
Call Signature
clone<
T
>(options?
):T
Defined in: packages/soukai/src/models/Model.ts:921
Type Parameters
T
T
extends Model
Parameters
options?
Partial
<{ clean
: boolean
; clones
: WeakMap
<Model
, Model
>; constructors
: WeakMap
<typeof Model
, typeof Model
> | [typeof Model
, typeof Model
][]; }>
Returns
T
Inherited from
SolidModelBase.clone
convertEngineFiltersToJsonLD()
protected
convertEngineFiltersToJsonLD(this
,filters
,compactIRIs
):EngineFilters
Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:72
Parameters
this
SolidModel
filters
compactIRIs
boolean
Returns
Inherited from
SolidModelBase.convertEngineFiltersToJsonLD
convertEngineUpdatesToJsonLD()
protected
convertEngineUpdatesToJsonLD(this
,updates
,compactIRIs
):EngineUpdates
Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:113
Parameters
this
SolidModel
updates
compactIRIs
boolean
Returns
Inherited from
SolidModelBase.convertEngineUpdatesToJsonLD
createFromEngineDocument()
protected
createFromEngineDocument(id
,document
,resourceId?
):Promise
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1183
Parameters
id
document
resourceId?
string
Returns
Promise
<SolidModel
>
Overrides
SolidModelBase.createFromEngineDocument
createManyFromEngineDocuments()
protected
createManyFromEngineDocuments(documents
):Promise
<SolidModel
[]>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1218
Parameters
documents
Record
<string
, EngineDocument
>
Returns
Promise
<SolidModel
[]>
Overrides
SolidModelBase.createManyFromEngineDocuments
delete()
delete():
Promise
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:807
Returns
Promise
<SolidModel
>
Overrides
SolidModelBase.delete
deleteModels()
protected
deleteModels(this
,models
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/DeletesModels.ts:16
Parameters
this
SolidModel
models
SolidModel
[]
Returns
Promise
<void
>
Inherited from
SolidModelBase.deleteModels
deleteModelsFromEngine()
protected
deleteModelsFromEngine(models
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1483
Parameters
models
SolidModel
[]
Returns
Promise
<void
>
Overrides
SolidModelBase.deleteModelsFromEngine
disableHistory()
disableHistory():
void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:105
Returns
void
Inherited from
SolidModelBase.disableHistory
disableTombstone()
disableTombstone():
void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:109
Returns
void
Inherited from
SolidModelBase.disableTombstone
documentContainsMany()
protected
documentContainsMany<T
>(model
):DocumentContainsManyRelation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1579
Type Parameters
T
T
extends typeof SolidModel
Parameters
model
T
Returns
documentExists()
documentExists():
boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:903
Returns
boolean
emit()
protected
emit<T
>(...args
):Promise
<void
>
Defined in: packages/soukai/src/models/Model.ts:1150
Type Parameters
T
T
extends keyof ModelEvents
Parameters
args
...ModelEmitArgs
<T
>
Returns
Promise
<void
>
Inherited from
SolidModelBase.emit
enableHistory()
enableHistory():
void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:101
Returns
void
Inherited from
SolidModelBase.enableHistory
enableTombstone()
enableTombstone():
void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:113
Returns
void
Inherited from
SolidModelBase.enableTombstone
exists()
exists():
boolean
Defined in: packages/soukai/src/models/Model.ts:908
Returns
boolean
Inherited from
SolidModelBase.exists
fetchPublicPermissions()
fetchPublicPermissions(
this
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:34
Parameters
this
SolidModel
Returns
Promise
<void
>
Inherited from
SolidModelBase.fetchPublicPermissions
fetchPublicPermissionsIfMissing()
fetchPublicPermissionsIfMissing(
this
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:28
Parameters
this
SolidModel
Returns
Promise
<void
>
Inherited from
SolidModelBase.fetchPublicPermissionsIfMissing
fixMalformedAttributes()
fixMalformedAttributes():
void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:977
Returns
void
Overrides
SolidModelBase.fixMalformedAttributes
forceDelete()
forceDelete():
Promise
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:815
Returns
Promise
<SolidModel
>
fresh()
fresh():
Promise
<SolidModel
>
Defined in: packages/soukai/src/models/Model.ts:522
Returns
Promise
<SolidModel
>
Inherited from
SolidModelBase.fresh
getAttribute()
getAttribute<
T
>(field
,includeUndefined
):T
Defined in: packages/soukai/src/models/Model.ts:772
Type Parameters
T
T
= unknown
Parameters
field
string
includeUndefined
boolean
= false
Returns
T
Inherited from
SolidModelBase.getAttribute
getAttributes()
getAttributes(
includeUndefined
):Attributes
Defined in: packages/soukai/src/models/Model.ts:793
Parameters
includeUndefined
boolean
= false
Returns
Inherited from
SolidModelBase.getAttributes
getAttributeValue()
getAttributeValue<
T
>(field
,includeUndefined
):T
Defined in: packages/soukai/src/models/Model.ts:778
Type Parameters
T
T
= unknown
Parameters
field
string
includeUndefined
boolean
= false
Returns
T
Inherited from
SolidModelBase.getAttributeValue
getCascadeModels()
protected
getCascadeModels():Promise
<Model
[]>
Defined in: packages/soukai/src/models/Model.ts:1171
Returns
Promise
<Model
[]>
Inherited from
SolidModelBase.getCascadeModels
getContainerUrl()
getContainerUrl():
null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1022
Returns
null
| string
getCreatedAtAttribute()
getCreatedAtAttribute():
Date
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1058
Returns
Date
getDefaultCollection()
protected
getDefaultCollection():string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1177
Returns
string
Overrides
SolidModelBase.getDefaultCollection
getDeletedAtAttribute()
getDeletedAtAttribute():
undefined
|Date
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1066
Returns
undefined
| Date
getDeletedPrimaryKey()
getDeletedPrimaryKey():
null
|Key
Defined in: packages/soukai/src/models/Model.ts:717
Returns
null
| Key
Inherited from
SolidModelBase.getDeletedPrimaryKey
getDirtyDocumentModels()
getDirtyDocumentModels():
SolidModel
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1105
Returns
SolidModel
[]
getDirtyEngineDocumentUpdates()
protected
getDirtyEngineDocumentUpdates(ignoreRelations?
):EngineUpdates
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1593
Parameters
ignoreRelations?
boolean
Returns
Overrides
SolidModelBase.getDirtyEngineDocumentUpdates
getDocumentModels()
getDocumentModels():
SolidModel
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1070
Returns
SolidModel
[]
getDocumentUrl()
getDocumentUrl():
null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:998
Returns
null
| string
getEngine()
getEngine():
undefined
|Engine
Defined in: packages/soukai/src/models/Model.ts:560
Returns
undefined
| Engine
Inherited from
SolidModelBase.getEngine
getFinalEngine()
getFinalEngine():
undefined
|Engine
Defined in: packages/soukai/src/models/Model.ts:564
Returns
undefined
| Engine
Inherited from
SolidModelBase.getFinalEngine
getHistoryHash()
getHistoryHash(
this
):null
|string
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:121
Parameters
this
Returns
null
| string
Inherited from
SolidModelBase.getHistoryHash
getIdAttribute()
getIdAttribute():
string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:893
Returns
string
getMalformedDocumentAttributes()
getMalformedDocumentAttributes():
Record
<string
,string
[]>
Defined in: packages/soukai/src/models/Model.ts:736
Returns
Record
<string
, string
[]>
Inherited from
SolidModelBase.getMalformedDocumentAttributes
getMetadataSchemaUpdates()
protected
getMetadataSchemaUpdates(this
,dirtyUrl
):EngineAttributeUpdateOperation
[]
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:197
Parameters
this
SolidModel
dirtyUrl
Nullable
<string
>
Returns
EngineAttributeUpdateOperation
[]
Inherited from
SolidModelBase.getMetadataSchemaUpdates
getOperationSchemaUpdates()
protected
getOperationSchemaUpdates(this
,model
,removedFields
,dirtyUrl
,options
):Promise
<EngineAttributeUpdateOperation
[]>
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:107
Parameters
this
SolidModel
model
SolidModel
removedFields
string
[]
dirtyUrl
Nullable
<string
>
options
Returns
Promise
<EngineAttributeUpdateOperation
[]>
Inherited from
SolidModelBase.getOperationSchemaUpdates
getOperationValue()
protected
getOperationValue(this
,field
,value
):unknown
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:343
Parameters
this
field
string
value
unknown
Returns
unknown
Inherited from
SolidModelBase.getOperationValue
getOriginalAttribute()
getOriginalAttribute<
T
>(field
):T
Defined in: packages/soukai/src/models/Model.ts:713
Type Parameters
T
T
= unknown
Parameters
field
string
Returns
T
Inherited from
SolidModelBase.getOriginalAttribute
getPrimaryKey()
getPrimaryKey():
null
|Key
Defined in: packages/soukai/src/models/Model.ts:853
Returns
null
| Key
Inherited from
SolidModelBase.getPrimaryKey
getRelatedModels()
getRelatedModels():
SolidModel
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1135
Returns
SolidModel
[]
getRelation()
getRelation<
T
>(relation
):null
|T
Defined in: packages/soukai/src/models/Model.ts:550
Type Parameters
T
T
extends Relation
<Model
, Model
, ModelConstructor
<Model
>> = Relation
<Model
, Model
, ModelConstructor
<Model
>>
Parameters
relation
string
Returns
null
| T
Inherited from
SolidModelBase.getRelation
getRelationModel()
Call Signature
getRelationModel<
T
>(relation
):null
|T
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1115
Type Parameters
T
T
extends SolidModel
Parameters
relation
string
Returns
null
| T
Overrides
SolidModelBase.getRelationModel
Call Signature
getRelationModel<
T
>(relation
):null
|T
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1116
Type Parameters
T
T
extends Model
Parameters
relation
string
Returns
null
| T
Overrides
SolidModelBase.getRelationModel
getRelationModels()
Call Signature
getRelationModels<
T
>(relation
):null
|T
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1121
Type Parameters
T
T
extends SolidModel
Parameters
relation
string
Returns
null
| T
[]
Overrides
SolidModelBase.getRelationModels
Call Signature
getRelationModels<
T
>(relation
):null
|T
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1122
Type Parameters
T
T
extends Model
Parameters
relation
string
Returns
null
| T
[]
Overrides
SolidModelBase.getRelationModels
getRemovedDocumentModels()
getRemovedDocumentModels():
SolidModel
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1086
Returns
SolidModel
[]
getResourceSchemaUpdate()
protected
getResourceSchemaUpdate(this
,model
,dirtyUrl?
):EngineAttributeUpdateOperation
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:231
Parameters
this
SolidModel
model
SolidModel
dirtyUrl?
Nullable
<string
>
Returns
EngineAttributeUpdateOperation
Inherited from
SolidModelBase.getResourceSchemaUpdate
getSchemaUpdates()
protected
getSchemaUpdates<T
>(this
,schema
,options
):Promise
<{model
:T
;updates
:EngineAttributeUpdateOperation
[]; }>
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:39
Type Parameters
T
T
extends SolidModel
Parameters
this
SolidModel
schema
options
Returns
Promise
<{ model
: T
; updates
: EngineAttributeUpdateOperation
[]; }>
Inherited from
SolidModelBase.getSchemaUpdates
getSerializedPrimaryKey()
getSerializedPrimaryKey():
null
|string
Defined in: packages/soukai/src/models/Model.ts:857
Returns
null
| string
Inherited from
SolidModelBase.getSerializedPrimaryKey
getSourceContainerUrl()
getSourceContainerUrl():
null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1028
Returns
null
| string
getSourceDocumentUrl()
getSourceDocumentUrl():
null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1010
Returns
null
| string
getUpdatedAtAttribute()
getUpdatedAtAttribute():
Date
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1062
Returns
Date
getUrlSchemaUpdates()
protected
getUrlSchemaUpdates(this
,dirtyUrl
):EngineAttributeUpdateOperation
[]
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:216
Parameters
this
SolidModel
dirtyUrl
Nullable
<string
>
Returns
EngineAttributeUpdateOperation
[]
Inherited from
SolidModelBase.getUrlSchemaUpdates
guessCollection()
protected
guessCollection():undefined
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1736
Returns
undefined
| string
hasAttribute()
hasAttribute(
field
):boolean
Defined in: packages/soukai/src/models/Model.ts:667
Parameters
field
string
Returns
boolean
Inherited from
SolidModelBase.hasAttribute
hasAttributeGetter()
hasAttributeGetter(
field
):boolean
Defined in: packages/soukai/src/models/Model.ts:799
Parameters
field
string
Returns
boolean
Inherited from
SolidModelBase.hasAttributeGetter
hasAttributeSetter()
hasAttributeSetter(
field
):boolean
Defined in: packages/soukai/src/models/Model.ts:703
Parameters
field
string
Returns
boolean
Inherited from
SolidModelBase.hasAttributeSetter
hasIncompleteAttributes()
hasIncompleteAttributes():
boolean
Defined in: packages/soukai/src/models/Model.ts:823
Returns
boolean
Inherited from
SolidModelBase.hasIncompleteAttributes
hasMany()
Call Signature
protected
hasMany<T
>(relatedClass
,foreignKeyField?
,localKeyField?
):SolidHasManyRelation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1510
Creates a relation when this model is referenced by multiple instances of another model.
Type Parameters
T
T
extends typeof SolidModel
Parameters
relatedClass
T
Related model class.
foreignKeyField?
string
Name of the foreign key field in the related model.
localKeyField?
string
Name of the local key field in the local model. Defaults to the primary key name defined in the local model class.
Returns
Overrides
SolidModelBase.hasMany
Call Signature
protected
hasMany<T
>(relatedClass
,foreignKeyField?
,localKeyField?
):Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1516
Type Parameters
T
T
extends typeof Model
Parameters
relatedClass
T
foreignKeyField?
string
localKeyField?
string
Returns
Overrides
SolidModelBase.hasMany
hasOne()
Call Signature
protected
hasOne<T
>(relatedClass
,foreignKeyField?
,localKeyField?
):SolidHasOneRelation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1488
Creates a relation when this model is referenced by one instance of another model.
Type Parameters
T
T
extends typeof SolidModel
Parameters
relatedClass
T
Related model class.
foreignKeyField?
string
Name of the foreign key field in the related model.
localKeyField?
string
Name of the local key field in the local model. Defaults to the primary key name defined in the local model class.
Returns
Overrides
SolidModelBase.hasOne
Call Signature
protected
hasOne<T
>(relatedClass
,foreignKeyField?
,localKeyField?
):Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1494
Type Parameters
T
T
extends typeof Model
Parameters
relatedClass
T
foreignKeyField?
string
localKeyField?
string
Returns
Overrides
SolidModelBase.hasOne
hasRelation()
hasRelation(
relation
):boolean
Defined in: packages/soukai/src/models/Model.ts:546
Parameters
relation
string
Returns
boolean
Inherited from
SolidModelBase.hasRelation
ignoreRdfPropertyHistory()
ignoreRdfPropertyHistory(
rdfProperty
,withSolidEngine?
):boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:994
Parameters
rdfProperty
string
withSolidEngine?
boolean
Returns
boolean
initialize()
protected
initialize(attributes
,exists
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:723
Parameters
attributes
exists
boolean
Returns
void
Overrides
SolidModelBase.initialize
initializeAttributes()
protected
initializeAttributes(attributes
,exists
):void
Defined in: packages/soukai/src/models/Model.ts:1018
Parameters
attributes
exists
boolean
Returns
void
Inherited from
SolidModelBase.initializeAttributes
initializeMetadataRelation()
protected
initializeMetadataRelation():void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:753
Returns
void
initializeProxy()
protected
initializeProxy():void
Defined in: packages/soukai/src/models/Model.ts:958
Returns
void
Inherited from
SolidModelBase.initializeProxy
initializeRelations()
protected
initializeRelations():void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:733
Returns
void
Overrides
SolidModelBase.initializeRelations
initializeRelationsEnabling()
protected
initializeRelationsEnabling():void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:740
Returns
void
is()
is(
another
):boolean
Defined in: packages/soukai/src/models/Model.ts:833
Parameters
another
this
Returns
boolean
Inherited from
SolidModelBase.is
isContainedBy()
protected
isContainedBy<T
>(model
):SolidIsContainedByRelation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1575
Type Parameters
T
T
extends typeof SolidContainer
Parameters
model
T
Returns
isDirty()
isDirty(
field?
,ignoreRelations?
):boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:918
Parameters
field?
string
ignoreRelations?
boolean
Returns
boolean
Overrides
SolidModelBase.isDirty
isRelationLoaded()
isRelationLoaded(
relation
):boolean
Defined in: packages/soukai/src/models/Model.ts:663
Parameters
relation
string
Returns
boolean
Inherited from
SolidModelBase.isRelationLoaded
isSoftDeleted()
isSoftDeleted():
boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:939
Returns
boolean
leavesTombstone()
leavesTombstone(
this
):boolean
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:117
Parameters
this
Returns
boolean
Inherited from
SolidModelBase.leavesTombstone
loadDocumentModels()
protected
loadDocumentModels(documentUrl
,document
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1254
Parameters
documentUrl
string
document
Returns
Promise
<void
>
loadEmptyRelations()
protected
loadEmptyRelations():Promise
<void
>
Defined in: packages/soukai/src/models/Model.ts:1269
Returns
Promise
<void
>
Inherited from
SolidModelBase.loadEmptyRelations
loadRelation()
loadRelation<
T
>(relation
):Promise
<T
>
Defined in: packages/soukai/src/models/Model.ts:578
Type Parameters
T
T
extends null
| Model
| Model
[] = null
| Model
| Model
[]
Parameters
relation
string
Returns
Promise
<T
>
Inherited from
SolidModelBase.loadRelation
loadRelationIfUnloaded()
loadRelationIfUnloaded<
T
>(relation
):Promise
<T
>
Defined in: packages/soukai/src/models/Model.ts:588
Type Parameters
T
T
extends null
| Model
| Model
[] = null
| Model
| Model
[]
Parameters
relation
string
Returns
Promise
<T
>
Inherited from
SolidModelBase.loadRelationIfUnloaded
markAttributeDirty()
protected
markAttributeDirty(field
,originalValue
,newValue
):boolean
Defined in: packages/soukai/src/models/Model.ts:1303
Parameters
field
string
originalValue
unknown
newValue
unknown
Returns
boolean
Inherited from
SolidModelBase.markAttributeDirty
metadataRelationship()
metadataRelationship():
Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1151
Returns
migrateSchema()
migrateSchema<
T
>(this
,schema
,options
):Promise
<T
>
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:22
Type Parameters
T
T
extends SolidModel
Parameters
this
SolidModel
schema
SolidSchemaDefinition
| SolidModelConstructor
<T
>
options
MigrateSchemaOptions
= {}
Returns
Promise
<T
>
Inherited from
SolidModelBase.migrateSchema
mintDocumentModelsKeys()
protected
mintDocumentModelsKeys(models
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1742
Parameters
models
SolidModel
[]
Returns
void
mintUrl()
mintUrl(
documentUrl?
,documentExists?
,resourceHash?
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:845
Parameters
documentUrl?
string
documentExists?
boolean
resourceHash?
string
Returns
void
newInstance()
newInstance<
T
>(this
, ...params
):T
Defined in: packages/soukai/src/models/Model.ts:516
Type Parameters
T
T
extends Model
Parameters
this
T
params
...[Attributes
, boolean
]
Returns
T
Inherited from
SolidModelBase.newInstance
newInstanceForSchema()
protected
newInstanceForSchema<T
>(this
,schema
,addedFields
,removedFields
):Promise
<T
>
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:59
Type Parameters
T
T
extends SolidModel
Parameters
this
SolidModel
schema
addedFields
string
[]
removedFields
string
[]
Returns
Promise
<T
>
Inherited from
SolidModelBase.newInstanceForSchema
newUniqueUrl()
protected
newUniqueUrl(url?
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1727
Parameters
url?
string
Returns
string
newUrl()
protected
newUrl(documentUrl?
,resourceHash?
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1703
Parameters
documentUrl?
string
resourceHash?
null
| string
Returns
string
newUrlDocumentUrl()
protected
newUrlDocumentUrl():string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1710
Returns
string
newUrlDocumentUrlSlug()
protected
newUrlDocumentUrlSlug():null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1716
Returns
null
| string
newUrlResourceHash()
protected
newUrlResourceHash():null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1723
Returns
null
| string
onMoved()
onMoved(
newResourceUrl
,newDocumentUrl?
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1171
Parameters
newResourceUrl
string
newDocumentUrl?
string
Returns
void
onPrimaryKeyUpdated()
protected
onPrimaryKeyUpdated(value
,oldValue
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1410
Parameters
value
null
| Key
oldValue
null
| Key
Returns
void
operationsRelationship()
operationsRelationship():
Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1159
Returns
parseEngineDocumentAttributes()
protected
parseEngineDocumentAttributes(id
,document
,resourceId?
):Promise
<Attributes
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1663
Parameters
id
document
resourceId?
string
Returns
Promise
<Attributes
>
Overrides
SolidModelBase.parseEngineDocumentAttributes
parseEngineDocumentAttributesFromJsonLD()
protected
parseEngineDocumentAttributesFromJsonLD(this
,document
,resourceId
):Promise
<Attributes
>
Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:36
Parameters
this
SolidModel
document
resourceId
string
Returns
Promise
<Attributes
>
Inherited from
SolidModelBase.parseEngineDocumentAttributesFromJsonLD
parseKey()
protected
parseKey(key
):Key
Defined in: packages/soukai/src/models/Model.ts:1463
Parameters
key
string
Returns
Inherited from
SolidModelBase.parseKey
performDelete()
protected
performDelete():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1376
Returns
Promise
<void
>
Overrides
SolidModelBase.performDelete
performMalformedAttributeFixes()
protected
performMalformedAttributeFixes():void
Defined in: packages/soukai/src/models/Model.ts:1131
Returns
void
Inherited from
SolidModelBase.performMalformedAttributeFixes
performSave()
protected
performSave():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1355
Returns
Promise
<void
>
Overrides
SolidModelBase.performSave
rebuildAttributesFromHistory()
rebuildAttributesFromHistory(
this
):void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:131
Parameters
this
Returns
void
Inherited from
SolidModelBase.rebuildAttributesFromHistory
reconcileModelTimestamps()
protected
reconcileModelTimestamps(this
,wasTouchedBeforeSaving
):void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:391
Parameters
this
wasTouchedBeforeSaving
boolean
Returns
void
Inherited from
SolidModelBase.reconcileModelTimestamps
registerInTypeIndex()
registerInTypeIndex(
typeIndexUrl
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:838
Parameters
typeIndexUrl
string
Returns
Promise
<void
>
removeDuplicatedHistoryOperations()
protected
removeDuplicatedHistoryOperations(this
):void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:315
Parameters
this
Returns
void
Inherited from
SolidModelBase.removeDuplicatedHistoryOperations
requireContainerUrl()
requireContainerUrl():
string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1018
Returns
string
requireDocumentUrl()
requireDocumentUrl():
string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1002
Returns
string
requireEngine()
requireEngine<
T
>():T
Defined in: packages/soukai/src/models/Model.ts:570
Type Parameters
T
T
extends Engine
Returns
T
Inherited from
SolidModelBase.requireEngine
requireFinalEngine()
requireFinalEngine<
T
>():T
Defined in: packages/soukai/src/models/Model.ts:574
Type Parameters
T
T
extends Engine
Returns
T
Inherited from
SolidModelBase.requireFinalEngine
requireRelation()
Call Signature
requireRelation<
T
>(relation
):T
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1109
Type Parameters
T
T
extends SolidRelation
= SolidRelation
Parameters
relation
string
Returns
T
Overrides
SolidModelBase.requireRelation
Call Signature
requireRelation<
T
>(relation
):T
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1110
Type Parameters
T
T
extends Relation
<Model
, Model
, ModelConstructor
<Model
>> = Relation
<Model
, Model
, ModelConstructor
<Model
>>
Parameters
relation
string
Returns
T
Overrides
SolidModelBase.requireRelation
reset()
reset():
void
Defined in: packages/soukai/src/models/Model.ts:847
Returns
void
Inherited from
SolidModelBase.reset
resetEngineData()
protected
resetEngineData():void
Defined in: packages/soukai/src/models/Model.ts:1201
Returns
void
Deprecated
use reset
instead.
Inherited from
SolidModelBase.resetEngineData
save()
save(
collection?
):Promise
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:789
Parameters
collection?
string
Returns
Promise
<SolidModel
>
Overrides
SolidModelBase.save
saveInDocument()
saveInDocument(
documentUrl
,resourceHash?
):Promise
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:793
Parameters
documentUrl
string
resourceHash?
string
Returns
Promise
<SolidModel
>
serializeKey()
protected
serializeKey(key
):string
Defined in: packages/soukai/src/models/Model.ts:1459
Parameters
key
Returns
string
Inherited from
SolidModelBase.serializeKey
serializeToJsonLD()
protected
serializeToJsonLD(this
,options
):JsonLD
Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:30
Parameters
this
SolidModel
options
Partial
= {}
Returns
JsonLD
Inherited from
SolidModelBase.serializeToJsonLD
setAttribute()
setAttribute(
field
,value
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1034
Parameters
field
string
value
unknown
Returns
void
Overrides
SolidModelBase.setAttribute
setAttributes()
setAttributes(
attributes
):void
Defined in: packages/soukai/src/models/Model.ts:730
Parameters
attributes
Returns
void
Inherited from
SolidModelBase.setAttributes
setAttributeValue()
setAttributeValue(
field
,value
):void
Defined in: packages/soukai/src/models/Model.ts:693
Parameters
field
string
value
unknown
Returns
void
Inherited from
SolidModelBase.setAttributeValue
setCreatedAtAttribute()
setCreatedAtAttribute(
value
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1050
Parameters
value
unknown
Returns
void
setDocumentExists()
setDocumentExists(
documentExists
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:907
Parameters
documentExists
boolean
Returns
void
setEngine()
setEngine(
engine?
):void
Defined in: packages/soukai/src/models/Model.ts:744
Parameters
engine?
Returns
void
Inherited from
SolidModelBase.setEngine
setExists()
setExists(
exists
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:897
Parameters
exists
boolean
Returns
void
Overrides
SolidModelBase.setExists
setMalformedDocumentAttributes()
setMalformedDocumentAttributes(
malformedAttributes
):void
Defined in: packages/soukai/src/models/Model.ts:740
Parameters
malformedAttributes
Record
<string
, string
[]>
Returns
void
Inherited from
SolidModelBase.setMalformedDocumentAttributes
setOriginalAttribute()
setOriginalAttribute(
field
,value
):void
Defined in: packages/soukai/src/models/Model.ts:721
Parameters
field
string
value
unknown
Returns
void
Inherited from
SolidModelBase.setOriginalAttribute
setRelationModel()
setRelationModel(
relation
,model
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1127
Parameters
relation
string
model
null
| SolidModel
Returns
void
Overrides
SolidModelBase.setRelationModel
setRelationModels()
setRelationModels(
relation
,models
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1131
Parameters
relation
string
models
null
| SolidModel
[]
Returns
void
Overrides
SolidModelBase.setRelationModels
setSourceDocumentUrl()
setSourceDocumentUrl(
sourceDocumentUrl
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1014
Parameters
sourceDocumentUrl
null
| string
Returns
void
setUpdatedAtAttribute()
setUpdatedAtAttribute(
value
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1054
Parameters
value
unknown
Returns
void
softDelete()
softDelete():
Promise
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:819
Returns
Promise
<SolidModel
>
static()
Call Signature
static(
property
):SolidBootedFieldsDefinition
Defined in: packages/soukai-solid/src/models/SolidModel.ts:777
Parameters
property
"fields"
Returns
Overrides
SolidModelBase.static
Call Signature
static(
property
):TimestampFieldValue
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:778
Parameters
property
"timestamps"
Returns
Overrides
SolidModelBase.static
Call Signature
static<
T
>():T
Defined in: packages/soukai-solid/src/models/SolidModel.ts:779
Type Parameters
T
T
extends typeof SolidModel
Returns
T
Overrides
SolidModelBase.static
Call Signature
static<
T
,K
>(property
):T
[K
]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:780
Type Parameters
T
T
extends typeof SolidModel
K
K
extends string
| number
| symbol
Parameters
property
K
Returns
T
[K
]
Overrides
SolidModelBase.static
syncDirty()
protected
syncDirty():Promise
<string
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1437
Returns
Promise
<string
>
Overrides
SolidModelBase.syncDirty
toEngineDocument()
protected
toEngineDocument():EngineDocument
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1583
Returns
Overrides
SolidModelBase.toEngineDocument
toJsonLD()
toJsonLD(
options
):Record
<string
,unknown
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:853
Parameters
options
SolidModelSerializationOptions
= {}
Returns
Record
<string
, unknown
>
tombstoneRelationship()
tombstoneRelationship():
Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1163
Returns
toTurtle()
toTurtle(
options
):Promise
<string
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:887
Parameters
options
SolidModelSerializationOptions
= {}
Returns
Promise
<string
>
touch()
touch():
void
Defined in: packages/soukai/src/models/Model.ts:900
Set the updatedAt
attribute to the current time.
Returns
void
Inherited from
SolidModelBase.touch
trackPublicPermissions()
protected
trackPublicPermissions(this
):PermissionsTracker
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:52
Parameters
this
SolidModel
Returns
Inherited from
SolidModelBase.trackPublicPermissions
tracksHistory()
tracksHistory(
this
):boolean
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:75
Parameters
this
Returns
boolean
Inherited from
SolidModelBase.tracksHistory
unloadRelation()
unloadRelation(
relation
):void
Defined in: packages/soukai/src/models/Model.ts:596
Parameters
relation
string
Returns
void
Inherited from
SolidModelBase.unloadRelation
unsetAttribute()
unsetAttribute(
field
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1044
Parameters
field
string
Returns
void
Overrides
SolidModelBase.unsetAttribute
update()
update(
attributes?
):Promise
<SolidModel
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:785
Parameters
attributes?
Returns
Promise
<SolidModel
>
Overrides
SolidModelBase.update
updateEngineDocumentSchema()
protected
updateEngineDocumentSchema(this
,graphUpdates
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:247
Parameters
this
SolidModel
graphUpdates
EngineAttributeUpdateOperation
[]
Returns
Promise
<void
>
Inherited from
SolidModelBase.updateEngineDocumentSchema
updatePublicPermissions()
updatePublicPermissions(
this
,permissions
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:44
Parameters
this
SolidModel
permissions
SolidDocumentPermission
[]
Returns
Promise
<void
>
Inherited from
SolidModelBase.updatePublicPermissions
usesRdfAliases()
usesRdfAliases():
boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1006
Returns
boolean
usingSolidEngine()
usingSolidEngine():
boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1147
Returns
boolean
wasRecentlyCreated()
wasRecentlyCreated():
boolean
Defined in: packages/soukai/src/models/Model.ts:912
Returns
boolean
Inherited from
SolidModelBase.wasRecentlyCreated
wasRecentlyDeleted()
wasRecentlyDeleted():
boolean
Defined in: packages/soukai/src/models/Model.ts:916
Returns
boolean
Inherited from
SolidModelBase.wasRecentlyDeleted
withEngine()
Call Signature
withEngine(
engine
):this
Defined in: packages/soukai/src/models/Model.ts:754
Parameters
engine
Returns
this
Inherited from
SolidModelBase.withEngine
Call Signature
withEngine<
T
>(engine
,operation
):T
Defined in: packages/soukai/src/models/Model.ts:755
Type Parameters
T
T
Parameters
engine
operation
(model
) => T
Returns
T
Inherited from
SolidModelBase.withEngine
Call Signature
withEngine<
T
>(engine
,operation
):Promise
<T
>
Defined in: packages/soukai/src/models/Model.ts:756
Type Parameters
T
T
Parameters
engine
operation
(model
) => Promise
<T
>
Returns
Promise
<T
>
Inherited from
SolidModelBase.withEngine
withoutTimestamps()
withoutTimestamps<
T
>(operation
):Promise
<T
>
Defined in: packages/soukai/src/models/Model.ts:766
Type Parameters
T
T
Parameters
operation
() => Promise
<T
>
Returns
Promise
<T
>
Inherited from
SolidModelBase.withoutTimestamps
withoutTrackingHistory()
Call Signature
withoutTrackingHistory<
T
>(this
,operation
):T
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:79
Type Parameters
T
T
Parameters
this
operation
() => T
Returns
T
Inherited from
SolidModelBase.withoutTrackingHistory
Call Signature
withoutTrackingHistory<
T
>(this
,operation
):Promise
<T
>
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:80
Type Parameters
T
T
Parameters
this
operation
() => Promise
<T
>
Returns
Promise
<T
>
Inherited from
SolidModelBase.withoutTrackingHistory
aliasRdfPrefixes()
static
aliasRdfPrefixes(aliases
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:257
Parameters
aliases
Record
<string
, string
>
Returns
void
all()
Call Signature
static
all<T
>(this
,filters?
):Promise
<T
[]>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:376
Type Parameters
T
T
extends Model
Parameters
this
filters?
Returns
Promise
<T
[]>
Overrides
SolidModelBase.all
Call Signature
static
all<T
>(this
,filters?
):Promise
<T
[]>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:377
Type Parameters
T
T
extends SolidModel
Parameters
this
filters?
Returns
Promise
<T
[]>
Overrides
SolidModelBase.all
at()
static
at<T
>(this
,parentUrl
):SolidModelConstructor
<T
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:233
Type Parameters
T
T
extends SolidModel
Parameters
this
parentUrl
string
Returns
boot()
static
boot(name?
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:240
Parameters
name?
string
Returns
void
Overrides
SolidModelBase.boot
bootClassDefinitions()
protected
static
bootClassDefinitions():object
Defined in: packages/soukai/src/models/Model.ts:409
Returns
object
attributeGetters
attributeGetters:
Map
<string
, () =>unknown
>
attributeSetters
attributeSetters:
Map
<string
, (value
) =>void
>
classFields
classFields:
string
[]
relations
relations:
string
[]
Inherited from
SolidModelBase.bootClassDefinitions
bootCollection()
protected
static
bootCollection():string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:612
Returns
string
Overrides
SolidModelBase.bootCollection
bootFields()
protected
static
bootFields(fields
,primaryKey
,timestamps
,fieldDefinitions
):object
Defined in: packages/soukai-solid/src/models/SolidModel.ts:626
Parameters
fields
undefined
| SolidFieldsDefinition
primaryKey
string
timestamps
fieldDefinitions
Returns
object
fieldAliases
fieldAliases:
Record
<string
,string
>
fields
fields:
BootedFieldsDefinition
Overrides
SolidModelBase.bootFields
bootHooks()
protected
static
bootHooks(hooks?
):Partial
Defined in: packages/soukai/src/models/Model.ts:455
Parameters
hooks?
Partial
<Record
<"beforeSave"
| "afterSave"
, (this
) => void
| Promise
<void
>>>
Returns
Partial
Inherited from
SolidModelBase.bootHooks
bootModelName()
protected
static
bootModelName(name?
):string
Defined in: packages/soukai/src/models/Model.ts:298
Parameters
name?
string
Returns
string
Inherited from
SolidModelBase.bootModelName
bootRdfContexts()
protected
static
bootRdfContexts(rdfContext
,rdfContexts
,rdfsClass
,options
):RDFContexts
Defined in: packages/soukai-solid/src/models/SolidModel.ts:520
Parameters
rdfContext
null
| string
rdfContexts
rdfsClass
undefined
| string
options
modelClass?
typeof SolidModel
skipParentSchema?
boolean
Returns
bootRdfsClasses()
protected
static
bootRdfsClasses(rdfsClass
,rdfsClasses
,rdfContexts
,initialClass?
):string
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:572
Parameters
rdfsClass
null
| string
rdfsClasses
null
| string
[]
rdfContexts
initialClass?
typeof SolidModel
Returns
string
[]
bootRdfsClassesAliases()
protected
static
bootRdfsClassesAliases(rdfsClassesAliases
,rdfContexts
):string
[][]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:605
Parameters
rdfsClassesAliases
string
[][]
rdfContexts
Returns
string
[][]
bootTimestamps()
protected
static
bootTimestamps(timestamps
,fieldDefinitions
):TimestampFieldValue
[]
Defined in: packages/soukai/src/models/Model.ts:322
Parameters
timestamps
undefined
| boolean
| TimestampFieldValue
[]
fieldDefinitions
Returns
Inherited from
SolidModelBase.bootTimestamps
create()
static
create<T
>(this
,attributes
):Promise
<T
>
Defined in: packages/soukai/src/models/Model.ts:124
Type Parameters
T
T
extends Model
Parameters
this
attributes
Attributes
= {}
Returns
Promise
<T
>
Inherited from
SolidModelBase.create
createFromEngineDocument()
Call Signature
static
createFromEngineDocument<T
>(this
,id
,document
,resourceId?
):Promise
<T
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:312
Type Parameters
T
T
extends SolidModel
Parameters
this
id
document
resourceId?
string
Returns
Promise
<T
>
Overrides
SolidModelBase.createFromEngineDocument
Call Signature
static
createFromEngineDocument<T
>(this
,id
,document
):Promise
<T
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:319
Type Parameters
T
T
extends Model
Parameters
this
id
document
Returns
Promise
<T
>
Overrides
SolidModelBase.createFromEngineDocument
createFromJsonLD()
static
createFromJsonLD<T
>(this
,jsonld
,baseUrl?
,resourceId?
):Promise
<T
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:470
Type Parameters
T
T
extends SolidModel
Parameters
this
jsonld
JsonLD
baseUrl?
string
resourceId?
string
Returns
Promise
<T
>
createInDocument()
static
createInDocument<T
>(this
,attributes
,documentUrl
,resourceHash?
):Promise
<T
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:479
Type Parameters
T
T
extends SolidModel
Parameters
this
attributes
documentUrl
string
resourceHash?
string
Returns
Promise
<T
>
createManyFromEngineDocuments()
static
createManyFromEngineDocuments<T
>(this
,documents
):Promise
<T
[]>
Defined in: packages/soukai/src/models/Model.ts:138
Type Parameters
T
T
extends Model
Parameters
this
documents
Record
<string
, EngineDocument
>
Returns
Promise
<T
[]>
Inherited from
SolidModelBase.createManyFromEngineDocuments
ensureBooted()
static
ensureBooted<T
>(this
):void
Defined in: packages/soukai/src/models/Model.ts:110
Type Parameters
T
T
extends Model
Parameters
this
Returns
void
Inherited from
SolidModelBase.ensureBooted
find()
Call Signature
static
find<T
>(this
,id
):Promise
<null
|T
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:335
Type Parameters
T
T
extends Model
Parameters
this
id
Returns
Promise
<null
| T
>
Overrides
SolidModelBase.find
Call Signature
static
find<T
>(this
,id
):Promise
<null
|T
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:336
Type Parameters
T
T
extends SolidModel
Parameters
this
id
Returns
Promise
<null
| T
>
Overrides
SolidModelBase.find
findMatchingResourceIds()
static
findMatchingResourceIds(quads
,baseUrl?
):string
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:501
Parameters
quads
Quad
[]
baseUrl?
string
Returns
string
[]
findOrFail()
static
findOrFail<T
>(this
,id
):Promise
<T
>
Defined in: packages/soukai/src/models/Model.ts:145
Type Parameters
T
T
extends Model
Parameters
this
id
Returns
Promise
<T
>
Inherited from
SolidModelBase.findOrFail
first()
static
first<T
>(this
,filters?
):Promise
<null
|T
>
Defined in: packages/soukai/src/models/Model.ts:174
Type Parameters
T
T
extends Model
Parameters
this
filters?
Returns
Promise
<null
| T
>
Inherited from
SolidModelBase.first
from()
static
from<T
>(this
,parentUrl
):SolidModelConstructor
<T
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:224
Type Parameters
T
T
extends SolidModel
Parameters
this
parentUrl
string
Returns
getDefaultRdfContext()
protected
static
getDefaultRdfContext(rdfContexts?
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:663
Parameters
rdfContexts?
Returns
string
getEngine()
static
getEngine():undefined
|Engine
Defined in: packages/soukai/src/models/Model.ts:212
Returns
undefined
| Engine
Inherited from
SolidModelBase.getEngine
getFieldDefinition()
static
getFieldDefinition(field
,value?
):SolidBootedFieldDefinition
Defined in: packages/soukai-solid/src/models/SolidModel.ts:153
Parameters
field
string
value?
unknown
Returns
getFieldRdfProperty()
static
getFieldRdfProperty(field
):null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:178
Parameters
field
string
Returns
null
| string
getFinalEngine()
static
getFinalEngine():undefined
|Engine
Defined in: packages/soukai/src/models/Model.ts:216
Returns
undefined
| Engine
Inherited from
SolidModelBase.getFinalEngine
getRdfPropertyField()
static
getRdfPropertyField(rdfProperty
):null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:188
Parameters
rdfProperty
string
Returns
null
| string
hasAutomaticTimestamp()
static
hasAutomaticTimestamp(timestamp
):boolean
Defined in: packages/soukai/src/models/Model.ts:204
Parameters
timestamp
Returns
boolean
Inherited from
SolidModelBase.hasAutomaticTimestamp
hasAutomaticTimestamps()
static
hasAutomaticTimestamps():boolean
Defined in: packages/soukai/src/models/Model.ts:208
Returns
boolean
Inherited from
SolidModelBase.hasAutomaticTimestamps
instance()
static
instance<T
>(this
):T
Defined in: packages/soukai/src/models/Model.ts:196
Type Parameters
T
T
extends Model
Parameters
this
Returns
T
Inherited from
SolidModelBase.instance
newFromJsonLD()
static
newFromJsonLD<T
>(this
,sourceJsonLD
,baseUrl?
,sourceResourceId?
):Promise
<T
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:421
Type Parameters
T
T
extends SolidModel
Parameters
this
sourceJsonLD
JsonLD
baseUrl?
string
sourceResourceId?
string
Returns
Promise
<T
>
newInstance()
static
newInstance<T
>(this
, ...params
):T
Defined in: packages/soukai/src/models/Model.ts:181
Type Parameters
T
T
extends Model
Parameters
this
params
...[Attributes
, boolean
]
Returns
T
Inherited from
SolidModelBase.newInstance
on()
static
on<TModel
,TEvent
>(this
,event
,listener
): () =>void
Defined in: packages/soukai/src/models/Model.ts:188
Type Parameters
TModel
TModel
extends Model
TEvent
TEvent
extends keyof ModelEvents | "schema-updated"
Parameters
this
ModelConstructor
<TModel
>
event
TEvent
listener
ModelListener
<TModel
, TEvent
>
Returns
():
void
Returns
void
Inherited from
SolidModelBase.on
performSchemaUpdate()
protected
static
performSchemaUpdate(schema
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:669
Parameters
schema
SolidSchemaDefinition
| SolidModelConstructor
Returns
Promise
<void
>
Overrides
SolidModelBase.performSchemaUpdate
prepareEngineFilters()
static
prepareEngineFilters(filters
):EngineFilters
Defined in: packages/soukai-solid/src/models/SolidModel.ts:400
Parameters
filters
EngineFilters
= {}
Returns
pureInstance()
protected
static
pureInstance<T
>(this
):T
Defined in: packages/soukai/src/models/Model.ts:290
Type Parameters
T
T
extends Model
Parameters
this
Returns
T
Inherited from
SolidModelBase.pureInstance
rdfTerm()
static
rdfTerm(property
,rdfContexts?
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:409
Parameters
property
string
rdfContexts?
Returns
string
replaceRdfPrefixes()
static
replaceRdfPrefixes(replacements
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:295
Parameters
replacements
Record
<string
, string
>
Returns
void
requireEngine()
static
requireEngine<T
>():T
Defined in: packages/soukai/src/models/Model.ts:222
Type Parameters
T
Returns
T
Inherited from
SolidModelBase.requireEngine
requireFetch()
static
requireFetch():Fetch
Defined in: packages/soukai-solid/src/models/SolidModel.ts:204
Returns
Fetch
requireFieldRdfProperty()
static
requireFieldRdfProperty(field
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:212
Parameters
field
string
Returns
string
requireFinalEngine()
static
requireFinalEngine<T
>():T
Defined in: packages/soukai/src/models/Model.ts:226
Type Parameters
T
Returns
T
Inherited from
SolidModelBase.requireFinalEngine
resetRdfAliases()
static
resetRdfAliases():void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:283
Returns
void
setEngine()
static
setEngine(engine?
):void
Defined in: packages/soukai/src/models/Model.ts:230
Parameters
engine?
Returns
void
Inherited from
SolidModelBase.setEngine
synchronize()
static
synchronize<T
>(this
,a
,b
,__models?
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:488
Type Parameters
T
T
extends SolidModel
Parameters
this
a
T
b
T
__models?
WeakSet
<SolidModel
>
Returns
Promise
<void
>
updateSchema()
Call Signature
static
updateSchema(schema
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:196
Parameters
schema
SolidSchemaDefinition
| SolidModelConstructor
Returns
Promise
<void
>
Overrides
SolidModelBase.updateSchema
Call Signature
static
updateSchema(schema
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:197
Parameters
schema
ModelConstructor
| Partial
<{ fields
: FieldsDefinition
<unknown
>; hooks?
: Partial
<Record
<"beforeSave"
| "afterSave"
, (this
) => void
| Promise
<void
>>>; primaryKey
: string
; timestamps
: TimestampsDefinition
; }>
Returns
Promise
<void
>
Overrides
SolidModelBase.updateSchema
useSoftDeletes()
static
useSoftDeletes(enabled
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:220
Parameters
enabled
boolean
Returns
void
usingSolidEngine()
static
usingSolidEngine():boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:216
Returns
boolean
withCollection()
static
withCollection<Result
>(collection
,operation?
):Promise
<Result
>
Defined in: packages/soukai/src/models/Model.ts:256
Type Parameters
Result
Result
Parameters
collection
undefined
| string
| () => Result
| Promise
<Result
>
operation?
() => Result
| Promise
<Result
>
Returns
Promise
<Result
>
Inherited from
SolidModelBase.withCollection
withEngine()
Call Signature
static
withEngine<T
>(this
,engine
):T
Defined in: packages/soukai/src/models/Model.ts:240
Type Parameters
T
T
Parameters
this
T
engine
Returns
T
Inherited from
SolidModelBase.withEngine
Call Signature
static
withEngine<T
>(engine
,operation
):T
Defined in: packages/soukai/src/models/Model.ts:241
Type Parameters
T
T
Parameters
engine
operation
() => T
Returns
T
Inherited from
SolidModelBase.withEngine
Call Signature
static
withEngine<T
>(engine
,operation
):Promise
<T
>
Defined in: packages/soukai/src/models/Model.ts:242
Type Parameters
T
T
Parameters
engine
operation
() => Promise
<T
>
Returns
Promise
<T
>
Inherited from
SolidModelBase.withEngine
withoutTimestamps()
static
withoutTimestamps<T
>(operation
):Promise
<T
>
Defined in: packages/soukai/src/models/Model.ts:284
Type Parameters
T
T
Parameters
operation
() => Promise
<T
>
Returns
Promise
<T
>
Inherited from
SolidModelBase.withoutTimestamps