Class: RemovePropertyOperation
Defined in: packages/soukai-solid/src/models/history/RemovePropertyOperation.ts:12
Extends
Constructors
Constructor
new RemovePropertyOperation(
attributes
,exists
):RemovePropertyOperation
Defined in: packages/soukai/src/models/Model.ts:487
Parameters
attributes
Attributes
= {}
exists
boolean
= false
Returns
RemovePropertyOperation
Inherited from
Model.constructor
Properties
_attributes
protected
_attributes:Attributes
Defined in: packages/soukai/src/models/Model.ts:478
Inherited from
Model._attributes
_dirtyAttributes
protected
_dirtyAttributes:Attributes
Defined in: packages/soukai/src/models/Model.ts:480
Inherited from
Model._dirtyAttributes
_documentExists
protected
_documentExists:boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:713
Inherited from
Model._documentExists
_exists
protected
_exists:boolean
Defined in: packages/soukai/src/models/Model.ts:475
Inherited from
Model._exists
_malformedDocumentAttributes
protected
_malformedDocumentAttributes:Record
<string
,string
[]>
Defined in: packages/soukai/src/models/Model.ts:481
Inherited from
Model._malformedDocumentAttributes
_originalAttributes
protected
_originalAttributes:Attributes
Defined in: packages/soukai/src/models/Model.ts:479
Inherited from
Model._originalAttributes
_proxy
protected
_proxy:RemovePropertyOperation
Defined in: packages/soukai/src/models/Model.ts:477
Inherited from
Model._proxy
_publicPermissions
protected
_publicPermissions:undefined
|SolidDocumentPermission
[]
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:18
Inherited from
Model._publicPermissions
_relations
protected
_relations:Record
<string
,SolidRelation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:718
Inherited from
Model._relations
_removedResourceUrls
protected
_removedResourceUrls:string
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:716
Inherited from
Model._removedResourceUrls
_sourceDocumentUrl
protected
_sourceDocumentUrl:null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:714
Inherited from
Model._sourceDocumentUrl
_trackedDirtyAttributes
protected
_trackedDirtyAttributes:Attributes
Defined in: packages/soukai-solid/src/models/SolidModel.ts:715
Inherited from
Model._trackedDirtyAttributes
_usesRdfAliases
protected
_usesRdfAliases:boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:717
Inherited from
Model._usesRdfAliases
_wasRecentlyCreated
protected
_wasRecentlyCreated:boolean
Defined in: packages/soukai/src/models/Model.ts:476
Inherited from
Model._wasRecentlyCreated
authorizations?
optional
authorizations:SolidACLAuthorization
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:704
Inherited from
Model.authorizations
createdAt
createdAt:
Date
Defined in: packages/soukai/src/models/inference.ts:47
Inherited from
Model.createdAt
date
date:
Date
Defined in: packages/soukai-solid/src/models/history/Operation.schema.ts:11
Inherited from
Model.date
deletedAt?
optional
deletedAt:Date
Defined in: packages/soukai-solid/src/models/SolidModel.ts:703
Inherited from
Model.deletedAt
id
id:
string
Defined in: packages/soukai/src/models/inference.ts:31
Inherited from
Model.id
metadata
metadata:
Metadata
Defined in: packages/soukai-solid/src/models/SolidModel.ts:705
Inherited from
Model.metadata
operations
operations:
Operation
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:706
Inherited from
Model.operations
property
property:
string
Defined in: packages/soukai-solid/src/models/history/PropertyOperation.schema.ts:10
Inherited from
Model.property
relatedAuthorizations
relatedAuthorizations:
SolidACLAuthorizationsRelation
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:708
Inherited from
Model.relatedAuthorizations
relatedMetadata
relatedMetadata:
SolidHasOneRelation
<RemovePropertyOperation
,Metadata
,SolidModelConstructor
<Metadata
>>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:709
Inherited from
Model.relatedMetadata
relatedOperations
relatedOperations:
OperationsRelation
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:710
Inherited from
Model.relatedOperations
relatedTombstone
relatedTombstone:
TombstoneRelation
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:711
Inherited from
Model.relatedTombstone
resourceUrl
resourceUrl:
string
Defined in: packages/soukai-solid/src/models/history/Operation.schema.ts:6
Inherited from
Model.resourceUrl
tombstone?
optional
tombstone:Tombstone
Defined in: packages/soukai-solid/src/models/SolidModel.ts:707
Inherited from
Model.tombstone
updatedAt
updatedAt:
Date
Defined in: packages/soukai/src/models/inference.ts:47
Inherited from
Model.updatedAt
url
url:
string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:701
Inherited from
Model.url
value
value:
any
Defined in: packages/soukai-solid/src/models/history/RemovePropertyOperation.schema.ts:12
Inherited from
Model.value
__attributeGetters
static
__attributeGetters:Map
<string
, () =>unknown
>
Defined in: packages/soukai/src/models/Model.ts:67
Inherited from
Model.__attributeGetters
__attributeSetters
static
__attributeSetters:Map
<string
, (value
) =>void
>
Defined in: packages/soukai/src/models/Model.ts:68
Inherited from
Model.__attributeSetters
__isSchema?
static
optional
__isSchema:boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:147
Inherited from
Model.__isSchema
classFields
static
classFields:string
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:135
Inherited from
Model.classFields
collection
static
collection:string
Defined in: packages/soukai/src/models/Model.ts:59
Inherited from
Model.collection
defaultResourceHash
static
defaultResourceHash:null
|string
='it'
Defined in: packages/soukai-solid/src/models/SolidModel.ts:142
Inherited from
Model.defaultResourceHash
fields
static
fields:SolidFieldsDefinition
Defined in: packages/soukai-solid/src/models/SolidModel.ts:134
Inherited from
Model.fields
history
static
history:boolean
=false
Defined in: packages/soukai-solid/src/models/SolidModel.ts:145
Inherited from
Model.history
historyDisabled
protected
static
historyDisabled:WeakMap
<SolidModel
,void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:150
Inherited from
Model.historyDisabled
hooks
static
hooks:Partial
={}
Defined in: packages/soukai/src/models/Model.ts:66
Inherited from
Model.hooks
mintsUrls
static
mintsUrls:boolean
=true
Defined in: packages/soukai-solid/src/models/SolidModel.ts:144
Inherited from
Model.mintsUrls
modelName
static
modelName:string
Defined in: packages/soukai/src/models/Model.ts:63
Inherited from
Model.modelName
primaryKey
static
primaryKey:string
='url'
Defined in: packages/soukai-solid/src/models/SolidModel.ts:133
Inherited from
Model.primaryKey
rdfContext?
static
optional
rdfContext:string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:136
Inherited from
Model.rdfContext
rdfContexts
static
rdfContexts:RDFContexts
={}
Defined in: packages/soukai-solid/src/models/SolidModel.ts:137
Inherited from
Model.rdfContexts
rdfPropertyFields?
protected
static
optional
rdfPropertyFields:Record
<string
,string
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:149
Inherited from
Model.rdfPropertyFields
rdfsClass?
static
optional
rdfsClass:string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:138
Inherited from
Model.rdfsClass
rdfsClasses
static
rdfsClasses:string
[] =[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:139
Inherited from
Model.rdfsClasses
rdfsClassesAliases
static
rdfsClassesAliases:string
[][] =[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:140
Inherited from
Model.rdfsClassesAliases
relations
static
relations:string
[] =[]
Defined in: packages/soukai/src/models/Model.ts:65
Inherited from
Model.relations
reservedRelations
static
reservedRelations:string
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:141
Inherited from
Model.reservedRelations
slugField?
static
optional
slugField:string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:143
Inherited from
Model.slugField
softDeletesEnabled
protected
static
softDeletesEnabled:boolean
=false
Defined in: packages/soukai-solid/src/models/SolidModel.ts:151
Inherited from
Model.softDeletesEnabled
timestamps
static
timestamps:TimestampsDefinition
Defined in: packages/soukai/src/models/Model.ts:61
Inherited from
Model.timestamps
tombstone
static
tombstone:boolean
=true
Defined in: packages/soukai-solid/src/models/SolidModel.ts:146
Inherited from
Model.tombstone
Accessors
isPrivate
Get Signature
get isPrivate():
null
|boolean
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:24
Returns
null
| boolean
Inherited from
Model.isPrivate
isPublic
Get Signature
get isPublic():
null
|boolean
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:20
Returns
null
| boolean
Inherited from
Model.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
Model.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
Model.addDirtyHistoryOperations
addHistoryOperations()
addHistoryOperations(
this
,operations
):void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:183
Parameters
this
operations
Returns
void
Inherited from
Model.addHistoryOperations
afterSave()
protected
afterSave(ignoreRelations?
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1384
Parameters
ignoreRelations?
boolean
Returns
Promise
<void
>
Inherited from
Model.afterSave
apply()
apply(
model
):void
Defined in: packages/soukai-solid/src/models/history/PropertyOperation.ts:7
Parameters
model
Returns
void
Inherited from
Model.apply
applyPropertyUpdate()
protected
applyPropertyUpdate(model
,field
):void
Defined in: packages/soukai-solid/src/models/history/RemovePropertyOperation.ts:16
Parameters
model
field
string
Returns
void
Overrides
Model.applyPropertyUpdate
attributeValueChanged()
protected
attributeValueChanged(originalValue
,newValue
):boolean
Defined in: packages/soukai/src/models/Model.ts:1297
Parameters
originalValue
unknown
newValue
unknown
Returns
boolean
Inherited from
Model.attributeValueChanged
authorizationsRelationship()
authorizationsRelationship():
Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1167
Returns
Inherited from
Model.authorizationsRelationship
beforeCreate()
protected
beforeCreate():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1315
Returns
Promise
<void
>
Inherited from
Model.beforeCreate
beforeDocumentSave()
protected
beforeDocumentSave():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1289
Returns
Promise
<void
>
Inherited from
Model.beforeDocumentSave
beforeSave()
protected
beforeSave(ignoreRelations?
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1271
Parameters
ignoreRelations?
boolean
Returns
Promise
<void
>
Inherited from
Model.beforeSave
beforeUpdate()
protected
beforeUpdate():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1335
Returns
Promise
<void
>
Inherited from
Model.beforeUpdate
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
Inherited from
Model.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
Inherited from
Model.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
Inherited from
Model.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
Inherited from
Model.belongsToOne
callAttributeGetter()
callAttributeGetter(
field
):unknown
Defined in: packages/soukai/src/models/Model.ts:803
Parameters
field
string
Returns
unknown
Inherited from
Model.callAttributeGetter
callAttributeSetter()
callAttributeSetter(
field
,value
):void
Defined in: packages/soukai/src/models/Model.ts:707
Parameters
field
string
value
unknown
Returns
void
Inherited from
Model.callAttributeSetter
castAttribute()
protected
castAttribute(value
,options
):unknown
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1671
Parameters
value
unknown
options
ModelCastAttributeOptions
= {}
Returns
unknown
Inherited from
Model.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
Model.castAttributes
cleanDirty()
cleanDirty(
ignoreRelations?
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:943
Parameters
ignoreRelations?
boolean
Returns
void
Inherited from
Model.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
Model.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
Model.clone
convertEngineFiltersToJsonLD()
protected
convertEngineFiltersToJsonLD(this
,filters
,compactIRIs
):EngineFilters
Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:72
Parameters
this
filters
compactIRIs
boolean
Returns
Inherited from
Model.convertEngineFiltersToJsonLD
convertEngineUpdatesToJsonLD()
protected
convertEngineUpdatesToJsonLD(this
,updates
,compactIRIs
):EngineUpdates
Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:113
Parameters
this
updates
compactIRIs
boolean
Returns
Inherited from
Model.convertEngineUpdatesToJsonLD
createFromEngineDocument()
protected
createFromEngineDocument(id
,document
,resourceId?
):Promise
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1183
Parameters
id
document
resourceId?
string
Returns
Promise
<RemovePropertyOperation
>
Inherited from
Model.createFromEngineDocument
createManyFromEngineDocuments()
protected
createManyFromEngineDocuments(documents
):Promise
<RemovePropertyOperation
[]>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1218
Parameters
documents
Record
<string
, EngineDocument
>
Returns
Promise
<RemovePropertyOperation
[]>
Inherited from
Model.createManyFromEngineDocuments
delete()
delete():
Promise
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:807
Returns
Promise
<RemovePropertyOperation
>
Inherited from
Model.delete
deleteModels()
protected
deleteModels(this
,models
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/DeletesModels.ts:16
Parameters
this
models
Returns
Promise
<void
>
Inherited from
Model.deleteModels
deleteModelsFromEngine()
protected
deleteModelsFromEngine(models
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1483
Parameters
models
RemovePropertyOperation
[]
Returns
Promise
<void
>
Inherited from
Model.deleteModelsFromEngine
disableHistory()
disableHistory():
void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:105
Returns
void
Inherited from
Model.disableHistory
disableTombstone()
disableTombstone():
void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:109
Returns
void
Inherited from
Model.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
Inherited from
Model.documentContainsMany
documentExists()
documentExists():
boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:903
Returns
boolean
Inherited from
Model.documentExists
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
Model.emit
enableHistory()
enableHistory():
void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:101
Returns
void
Inherited from
Model.enableHistory
enableTombstone()
enableTombstone():
void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:113
Returns
void
Inherited from
Model.enableTombstone
exists()
exists():
boolean
Defined in: packages/soukai/src/models/Model.ts:908
Returns
boolean
Inherited from
Model.exists
fetchPublicPermissions()
fetchPublicPermissions(
this
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:34
Parameters
this
Returns
Promise
<void
>
Inherited from
Model.fetchPublicPermissions
fetchPublicPermissionsIfMissing()
fetchPublicPermissionsIfMissing(
this
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:28
Parameters
this
Returns
Promise
<void
>
Inherited from
Model.fetchPublicPermissionsIfMissing
fixMalformedAttributes()
fixMalformedAttributes():
void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:977
Returns
void
Inherited from
Model.fixMalformedAttributes
forceDelete()
forceDelete():
Promise
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:815
Returns
Promise
<RemovePropertyOperation
>
Inherited from
Model.forceDelete
fresh()
fresh():
Promise
<RemovePropertyOperation
>
Defined in: packages/soukai/src/models/Model.ts:522
Returns
Promise
<RemovePropertyOperation
>
Inherited from
Model.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
Model.getAttribute
getAttributes()
getAttributes(
includeUndefined
):Attributes
Defined in: packages/soukai/src/models/Model.ts:793
Parameters
includeUndefined
boolean
= false
Returns
Inherited from
Model.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
Model.getAttributeValue
getCascadeModels()
protected
getCascadeModels():Promise
<Model
[]>
Defined in: packages/soukai/src/models/Model.ts:1171
Returns
Promise
<Model
[]>
Inherited from
Model.getCascadeModels
getContainerUrl()
getContainerUrl():
null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1022
Returns
null
| string
Inherited from
Model.getContainerUrl
getCreatedAtAttribute()
getCreatedAtAttribute():
Date
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1058
Returns
Date
Inherited from
Model.getCreatedAtAttribute
getDefaultCollection()
protected
getDefaultCollection():string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1177
Returns
string
Inherited from
Model.getDefaultCollection
getDeletedAtAttribute()
getDeletedAtAttribute():
undefined
|Date
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1066
Returns
undefined
| Date
Inherited from
Model.getDeletedAtAttribute
getDeletedPrimaryKey()
getDeletedPrimaryKey():
null
|Key
Defined in: packages/soukai/src/models/Model.ts:717
Returns
null
| Key
Inherited from
Model.getDeletedPrimaryKey
getDirtyDocumentModels()
getDirtyDocumentModels():
SolidModel
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1105
Returns
Inherited from
Model.getDirtyDocumentModels
getDirtyEngineDocumentUpdates()
protected
getDirtyEngineDocumentUpdates(ignoreRelations?
):EngineUpdates
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1593
Parameters
ignoreRelations?
boolean
Returns
Inherited from
Model.getDirtyEngineDocumentUpdates
getDocumentModels()
getDocumentModels():
SolidModel
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1070
Returns
Inherited from
Model.getDocumentModels
getDocumentUrl()
getDocumentUrl():
null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:998
Returns
null
| string
Inherited from
Model.getDocumentUrl
getEngine()
getEngine():
undefined
|Engine
Defined in: packages/soukai/src/models/Model.ts:560
Returns
undefined
| Engine
Inherited from
Model.getEngine
getFinalEngine()
getFinalEngine():
undefined
|Engine
Defined in: packages/soukai/src/models/Model.ts:564
Returns
undefined
| Engine
Inherited from
Model.getFinalEngine
getHistoryHash()
getHistoryHash(
this
):null
|string
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:121
Parameters
this
Returns
null
| string
Inherited from
Model.getHistoryHash
getIdAttribute()
getIdAttribute():
string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:893
Returns
string
Inherited from
Model.getIdAttribute
getMalformedDocumentAttributes()
getMalformedDocumentAttributes():
Record
<string
,string
[]>
Defined in: packages/soukai/src/models/Model.ts:736
Returns
Record
<string
, string
[]>
Inherited from
Model.getMalformedDocumentAttributes
getMetadataSchemaUpdates()
protected
getMetadataSchemaUpdates(this
,dirtyUrl
):EngineAttributeUpdateOperation
[]
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:197
Parameters
this
dirtyUrl
Nullable
<string
>
Returns
EngineAttributeUpdateOperation
[]
Inherited from
Model.getMetadataSchemaUpdates
getOperationSchemaUpdates()
protected
getOperationSchemaUpdates(this
,model
,removedFields
,dirtyUrl
,options
):Promise
<EngineAttributeUpdateOperation
[]>
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:107
Parameters
this
model
removedFields
string
[]
dirtyUrl
Nullable
<string
>
options
Returns
Promise
<EngineAttributeUpdateOperation
[]>
Inherited from
Model.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
Model.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
Model.getOriginalAttribute
getPrimaryKey()
getPrimaryKey():
null
|Key
Defined in: packages/soukai/src/models/Model.ts:853
Returns
null
| Key
Inherited from
Model.getPrimaryKey
getRelatedModels()
getRelatedModels():
SolidModel
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1135
Returns
Inherited from
Model.getRelatedModels
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
Model.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
Inherited from
Model.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
Inherited from
Model.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
[]
Inherited from
Model.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
[]
Inherited from
Model.getRelationModels
getRemovedDocumentModels()
getRemovedDocumentModels():
SolidModel
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1086
Returns
Inherited from
Model.getRemovedDocumentModels
getResourceSchemaUpdate()
protected
getResourceSchemaUpdate(this
,model
,dirtyUrl?
):EngineAttributeUpdateOperation
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:231
Parameters
this
model
dirtyUrl?
Nullable
<string
>
Returns
EngineAttributeUpdateOperation
Inherited from
Model.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
schema
options
Returns
Promise
<{ model
: T
; updates
: EngineAttributeUpdateOperation
[]; }>
Inherited from
Model.getSchemaUpdates
getSerializedPrimaryKey()
getSerializedPrimaryKey():
null
|string
Defined in: packages/soukai/src/models/Model.ts:857
Returns
null
| string
Inherited from
Model.getSerializedPrimaryKey
getSourceContainerUrl()
getSourceContainerUrl():
null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1028
Returns
null
| string
Inherited from
Model.getSourceContainerUrl
getSourceDocumentUrl()
getSourceDocumentUrl():
null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1010
Returns
null
| string
Inherited from
Model.getSourceDocumentUrl
getUpdatedAtAttribute()
getUpdatedAtAttribute():
Date
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1062
Returns
Date
Inherited from
Model.getUpdatedAtAttribute
getUrlSchemaUpdates()
protected
getUrlSchemaUpdates(this
,dirtyUrl
):EngineAttributeUpdateOperation
[]
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:216
Parameters
this
dirtyUrl
Nullable
<string
>
Returns
EngineAttributeUpdateOperation
[]
Inherited from
Model.getUrlSchemaUpdates
guessCollection()
protected
guessCollection():undefined
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1736
Returns
undefined
| string
Inherited from
Model.guessCollection
hasAttribute()
hasAttribute(
field
):boolean
Defined in: packages/soukai/src/models/Model.ts:667
Parameters
field
string
Returns
boolean
Inherited from
Model.hasAttribute
hasAttributeGetter()
hasAttributeGetter(
field
):boolean
Defined in: packages/soukai/src/models/Model.ts:799
Parameters
field
string
Returns
boolean
Inherited from
Model.hasAttributeGetter
hasAttributeSetter()
hasAttributeSetter(
field
):boolean
Defined in: packages/soukai/src/models/Model.ts:703
Parameters
field
string
Returns
boolean
Inherited from
Model.hasAttributeSetter
hasIncompleteAttributes()
hasIncompleteAttributes():
boolean
Defined in: packages/soukai/src/models/Model.ts:823
Returns
boolean
Inherited from
Model.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
Inherited from
Model.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
Inherited from
Model.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
Inherited from
Model.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
Inherited from
Model.hasOne
hasRelation()
hasRelation(
relation
):boolean
Defined in: packages/soukai/src/models/Model.ts:546
Parameters
relation
string
Returns
boolean
Inherited from
Model.hasRelation
ignoreRdfPropertyHistory()
ignoreRdfPropertyHistory(
rdfProperty
,withSolidEngine?
):boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:994
Parameters
rdfProperty
string
withSolidEngine?
boolean
Returns
boolean
Inherited from
Model.ignoreRdfPropertyHistory
initialize()
protected
initialize(attributes
,exists
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:723
Parameters
attributes
exists
boolean
Returns
void
Inherited from
Model.initialize
initializeAttributes()
protected
initializeAttributes(attributes
,exists
):void
Defined in: packages/soukai/src/models/Model.ts:1018
Parameters
attributes
exists
boolean
Returns
void
Inherited from
Model.initializeAttributes
initializeMetadataRelation()
protected
initializeMetadataRelation():void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:753
Returns
void
Inherited from
Model.initializeMetadataRelation
initializeProxy()
protected
initializeProxy():void
Defined in: packages/soukai/src/models/Model.ts:958
Returns
void
Inherited from
Model.initializeProxy
initializeRelations()
protected
initializeRelations():void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:733
Returns
void
Inherited from
Model.initializeRelations
initializeRelationsEnabling()
protected
initializeRelationsEnabling():void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:740
Returns
void
Inherited from
Model.initializeRelationsEnabling
is()
is(
another
):boolean
Defined in: packages/soukai/src/models/Model.ts:833
Parameters
another
this
Returns
boolean
Inherited from
Model.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
Inherited from
Model.isContainedBy
isDirty()
isDirty(
field?
,ignoreRelations?
):boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:918
Parameters
field?
string
ignoreRelations?
boolean
Returns
boolean
Inherited from
Model.isDirty
isInception()
isInception(
parent
):boolean
Defined in: packages/soukai-solid/src/models/history/Operation.ts:14
Parameters
parent
Returns
boolean
Inherited from
Model.isInception
isRelationLoaded()
isRelationLoaded(
relation
):boolean
Defined in: packages/soukai/src/models/Model.ts:663
Parameters
relation
string
Returns
boolean
Inherited from
Model.isRelationLoaded
isSoftDeleted()
isSoftDeleted():
boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:939
Returns
boolean
Inherited from
Model.isSoftDeleted
leavesTombstone()
leavesTombstone(
this
):boolean
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:117
Parameters
this
Returns
boolean
Inherited from
Model.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
>
Inherited from
Model.loadDocumentModels
loadEmptyRelations()
protected
loadEmptyRelations():Promise
<void
>
Defined in: packages/soukai/src/models/Model.ts:1269
Returns
Promise
<void
>
Inherited from
Model.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
Model.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
Model.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
Model.markAttributeDirty
metadataRelationship()
metadataRelationship():
Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1151
Returns
Inherited from
Model.metadataRelationship
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
schema
SolidSchemaDefinition
| SolidModelConstructor
<T
>
options
MigrateSchemaOptions
= {}
Returns
Promise
<T
>
Inherited from
Model.migrateSchema
mintDocumentModelsKeys()
protected
mintDocumentModelsKeys(models
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1742
Parameters
models
Returns
void
Inherited from
Model.mintDocumentModelsKeys
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
Inherited from
Model.mintUrl
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
Model.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
schema
addedFields
string
[]
removedFields
string
[]
Returns
Promise
<T
>
Inherited from
Model.newInstanceForSchema
newUniqueUrl()
protected
newUniqueUrl(url?
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1727
Parameters
url?
string
Returns
string
Inherited from
Model.newUniqueUrl
newUrl()
Call Signature
protected
newUrl(documentUrl?
,resourceHash?
):string
Defined in: packages/soukai-solid/src/models/history/Operation.ts:18
Parameters
documentUrl?
string
resourceHash?
string
Returns
string
Inherited from
Model.newUrl
Call Signature
protected
newUrl(documentUrl?
,resourceHash?
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1703
Parameters
documentUrl?
string
resourceHash?
null
| string
Returns
string
Inherited from
Model.newUrl
newUrlDocumentUrl()
protected
newUrlDocumentUrl():string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1710
Returns
string
Inherited from
Model.newUrlDocumentUrl
newUrlDocumentUrlSlug()
protected
newUrlDocumentUrlSlug():null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1716
Returns
null
| string
Inherited from
Model.newUrlDocumentUrlSlug
newUrlResourceHash()
protected
newUrlResourceHash():null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1723
Returns
null
| string
Inherited from
Model.newUrlResourceHash
onMoved()
onMoved(
newResourceUrl
,newDocumentUrl?
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1171
Parameters
newResourceUrl
string
newDocumentUrl?
string
Returns
void
Inherited from
Model.onMoved
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
Inherited from
Model.onPrimaryKeyUpdated
operationsRelationship()
operationsRelationship():
Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1159
Returns
Inherited from
Model.operationsRelationship
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
>
Inherited from
Model.parseEngineDocumentAttributes
parseEngineDocumentAttributesFromJsonLD()
protected
parseEngineDocumentAttributesFromJsonLD(this
,document
,resourceId
):Promise
<Attributes
>
Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:36
Parameters
this
document
resourceId
string
Returns
Promise
<Attributes
>
Inherited from
Model.parseEngineDocumentAttributesFromJsonLD
parseKey()
protected
parseKey(key
):Key
Defined in: packages/soukai/src/models/Model.ts:1463
Parameters
key
string
Returns
Inherited from
Model.parseKey
performDelete()
protected
performDelete():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1376
Returns
Promise
<void
>
Inherited from
Model.performDelete
performMalformedAttributeFixes()
protected
performMalformedAttributeFixes():void
Defined in: packages/soukai/src/models/Model.ts:1131
Returns
void
Inherited from
Model.performMalformedAttributeFixes
performSave()
protected
performSave():Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1355
Returns
Promise
<void
>
Inherited from
Model.performSave
rebuildAttributesFromHistory()
rebuildAttributesFromHistory(
this
):void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:131
Parameters
this
Returns
void
Inherited from
Model.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
Model.reconcileModelTimestamps
registerInTypeIndex()
registerInTypeIndex(
typeIndexUrl
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:838
Parameters
typeIndexUrl
string
Returns
Promise
<void
>
Inherited from
Model.registerInTypeIndex
removeDuplicatedHistoryOperations()
protected
removeDuplicatedHistoryOperations(this
):void
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:315
Parameters
this
Returns
void
Inherited from
Model.removeDuplicatedHistoryOperations
requireContainerUrl()
requireContainerUrl():
string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1018
Returns
string
Inherited from
Model.requireContainerUrl
requireDocumentUrl()
requireDocumentUrl():
string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1002
Returns
string
Inherited from
Model.requireDocumentUrl
requireEngine()
requireEngine<
T
>():T
Defined in: packages/soukai/src/models/Model.ts:570
Type Parameters
T
T
extends Engine
Returns
T
Inherited from
Model.requireEngine
requireFinalEngine()
requireFinalEngine<
T
>():T
Defined in: packages/soukai/src/models/Model.ts:574
Type Parameters
T
T
extends Engine
Returns
T
Inherited from
Model.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
Inherited from
Model.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
Inherited from
Model.requireRelation
reset()
reset():
void
Defined in: packages/soukai/src/models/Model.ts:847
Returns
void
Inherited from
Model.reset
resetEngineData()
protected
resetEngineData():void
Defined in: packages/soukai/src/models/Model.ts:1201
Returns
void
Deprecated
use reset
instead.
Inherited from
Model.resetEngineData
save()
save(
collection?
):Promise
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:789
Parameters
collection?
string
Returns
Promise
<RemovePropertyOperation
>
Inherited from
Model.save
saveInDocument()
saveInDocument(
documentUrl
,resourceHash?
):Promise
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:793
Parameters
documentUrl
string
resourceHash?
string
Returns
Promise
<RemovePropertyOperation
>
Inherited from
Model.saveInDocument
serializeKey()
protected
serializeKey(key
):string
Defined in: packages/soukai/src/models/Model.ts:1459
Parameters
key
Returns
string
Inherited from
Model.serializeKey
serializeToJsonLD()
protected
serializeToJsonLD(this
,options
):JsonLD
Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:30
Parameters
this
options
Partial
= {}
Returns
JsonLD
Inherited from
Model.serializeToJsonLD
setAttribute()
setAttribute(
field
,value
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1034
Parameters
field
string
value
unknown
Returns
void
Inherited from
Model.setAttribute
setAttributes()
setAttributes(
attributes
):void
Defined in: packages/soukai/src/models/Model.ts:730
Parameters
attributes
Returns
void
Inherited from
Model.setAttributes
setAttributeValue()
setAttributeValue(
field
,value
):void
Defined in: packages/soukai/src/models/Model.ts:693
Parameters
field
string
value
unknown
Returns
void
Inherited from
Model.setAttributeValue
setCreatedAtAttribute()
setCreatedAtAttribute(
value
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1050
Parameters
value
unknown
Returns
void
Inherited from
Model.setCreatedAtAttribute
setDocumentExists()
setDocumentExists(
documentExists
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:907
Parameters
documentExists
boolean
Returns
void
Inherited from
Model.setDocumentExists
setEngine()
setEngine(
engine?
):void
Defined in: packages/soukai/src/models/Model.ts:744
Parameters
engine?
Returns
void
Inherited from
Model.setEngine
setExists()
setExists(
exists
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:897
Parameters
exists
boolean
Returns
void
Inherited from
Model.setExists
setMalformedDocumentAttributes()
setMalformedDocumentAttributes(
malformedAttributes
):void
Defined in: packages/soukai/src/models/Model.ts:740
Parameters
malformedAttributes
Record
<string
, string
[]>
Returns
void
Inherited from
Model.setMalformedDocumentAttributes
setOriginalAttribute()
setOriginalAttribute(
field
,value
):void
Defined in: packages/soukai/src/models/Model.ts:721
Parameters
field
string
value
unknown
Returns
void
Inherited from
Model.setOriginalAttribute
setRelationModel()
setRelationModel(
relation
,model
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1127
Parameters
relation
string
model
null
| SolidModel
Returns
void
Inherited from
Model.setRelationModel
setRelationModels()
setRelationModels(
relation
,models
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1131
Parameters
relation
string
models
null
| SolidModel
[]
Returns
void
Inherited from
Model.setRelationModels
setSourceDocumentUrl()
setSourceDocumentUrl(
sourceDocumentUrl
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1014
Parameters
sourceDocumentUrl
null
| string
Returns
void
Inherited from
Model.setSourceDocumentUrl
setUpdatedAtAttribute()
setUpdatedAtAttribute(
value
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1054
Parameters
value
unknown
Returns
void
Inherited from
Model.setUpdatedAtAttribute
softDelete()
softDelete():
Promise
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:819
Returns
Promise
<RemovePropertyOperation
>
Inherited from
Model.softDelete
static()
Call Signature
static(
property
):SolidBootedFieldsDefinition
Defined in: packages/soukai-solid/src/models/SolidModel.ts:777
Parameters
property
"fields"
Returns
Inherited from
Model.static
Call Signature
static(
property
):TimestampFieldValue
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:778
Parameters
property
"timestamps"
Returns
Inherited from
Model.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
Inherited from
Model.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
]
Inherited from
Model.static
syncDirty()
protected
syncDirty():Promise
<string
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1437
Returns
Promise
<string
>
Inherited from
Model.syncDirty
toEngineDocument()
protected
toEngineDocument():EngineDocument
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1583
Returns
Inherited from
Model.toEngineDocument
toJsonLD()
toJsonLD(
options
):Record
<string
,unknown
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:853
Parameters
options
SolidModelSerializationOptions
= {}
Returns
Record
<string
, unknown
>
Inherited from
Model.toJsonLD
tombstoneRelationship()
tombstoneRelationship():
Relation
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1163
Returns
Inherited from
Model.tombstoneRelationship
toTurtle()
toTurtle(
options
):Promise
<string
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:887
Parameters
options
SolidModelSerializationOptions
= {}
Returns
Promise
<string
>
Inherited from
Model.toTurtle
touch()
touch():
void
Defined in: packages/soukai/src/models/Model.ts:900
Set the updatedAt
attribute to the current time.
Returns
void
Inherited from
Model.touch
trackPublicPermissions()
protected
trackPublicPermissions(this
):PermissionsTracker
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:52
Parameters
this
Returns
Inherited from
Model.trackPublicPermissions
tracksHistory()
tracksHistory(
this
):boolean
Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:75
Parameters
this
Returns
boolean
Inherited from
Model.tracksHistory
unloadRelation()
unloadRelation(
relation
):void
Defined in: packages/soukai/src/models/Model.ts:596
Parameters
relation
string
Returns
void
Inherited from
Model.unloadRelation
unsetAttribute()
unsetAttribute(
field
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1044
Parameters
field
string
Returns
void
Inherited from
Model.unsetAttribute
update()
update(
attributes?
):Promise
<RemovePropertyOperation
>
Defined in: packages/soukai-solid/src/models/SolidModel.ts:785
Parameters
attributes?
Returns
Promise
<RemovePropertyOperation
>
Inherited from
Model.update
updateEngineDocumentSchema()
protected
updateEngineDocumentSchema(this
,graphUpdates
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:247
Parameters
this
graphUpdates
EngineAttributeUpdateOperation
[]
Returns
Promise
<void
>
Inherited from
Model.updateEngineDocumentSchema
updatePublicPermissions()
updatePublicPermissions(
this
,permissions
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:44
Parameters
this
permissions
SolidDocumentPermission
[]
Returns
Promise
<void
>
Inherited from
Model.updatePublicPermissions
usesRdfAliases()
usesRdfAliases():
boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1006
Returns
boolean
Inherited from
Model.usesRdfAliases
usingSolidEngine()
usingSolidEngine():
boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:1147
Returns
boolean
Inherited from
Model.usingSolidEngine
wasRecentlyCreated()
wasRecentlyCreated():
boolean
Defined in: packages/soukai/src/models/Model.ts:912
Returns
boolean
Inherited from
Model.wasRecentlyCreated
wasRecentlyDeleted()
wasRecentlyDeleted():
boolean
Defined in: packages/soukai/src/models/Model.ts:916
Returns
boolean
Inherited from
Model.wasRecentlyDeleted
withEngine()
Call Signature
withEngine(
engine
):this
Defined in: packages/soukai/src/models/Model.ts:754
Parameters
engine
Returns
this
Inherited from
Model.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
Model.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
Model.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
Model.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
Model.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
Model.withoutTrackingHistory
aliasRdfPrefixes()
static
aliasRdfPrefixes(aliases
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:257
Parameters
aliases
Record
<string
, string
>
Returns
void
Inherited from
Model.aliasRdfPrefixes
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
[]>
Inherited from
Model.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
[]>
Inherited from
Model.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
Inherited from
Model.at
boot()
static
boot(name?
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:240
Parameters
name?
string
Returns
void
Inherited from
Model.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
Model.bootClassDefinitions
bootCollection()
protected
static
bootCollection():string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:612
Returns
string
Inherited from
Model.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
Inherited from
Model.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
Model.bootHooks
bootModelName()
protected
static
bootModelName(name?
):string
Defined in: packages/soukai/src/models/Model.ts:298
Parameters
name?
string
Returns
string
Inherited from
Model.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
Inherited from
Model.bootRdfContexts
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
[]
Inherited from
Model.bootRdfsClasses
bootRdfsClassesAliases()
protected
static
bootRdfsClassesAliases(rdfsClassesAliases
,rdfContexts
):string
[][]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:605
Parameters
rdfsClassesAliases
string
[][]
rdfContexts
Returns
string
[][]
Inherited from
Model.bootRdfsClassesAliases
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
Model.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
Model.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
>
Inherited from
Model.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
>
Inherited from
Model.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
>
Inherited from
Model.createFromJsonLD
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
>
Inherited from
Model.createInDocument
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
Model.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
Model.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
>
Inherited from
Model.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
>
Inherited from
Model.find
findMatchingResourceIds()
static
findMatchingResourceIds(quads
,baseUrl?
):string
[]
Defined in: packages/soukai-solid/src/models/SolidModel.ts:501
Parameters
quads
Quad
[]
baseUrl?
string
Returns
string
[]
Inherited from
Model.findMatchingResourceIds
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
Model.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
Model.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
Inherited from
Model.from
getDefaultRdfContext()
protected
static
getDefaultRdfContext(rdfContexts?
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:663
Parameters
rdfContexts?
Returns
string
Inherited from
Model.getDefaultRdfContext
getEngine()
static
getEngine():undefined
|Engine
Defined in: packages/soukai/src/models/Model.ts:212
Returns
undefined
| Engine
Inherited from
Model.getEngine
getFieldDefinition()
static
getFieldDefinition(field
,value?
):SolidBootedFieldDefinition
Defined in: packages/soukai-solid/src/models/SolidModel.ts:153
Parameters
field
string
value?
unknown
Returns
Inherited from
Model.getFieldDefinition
getFieldRdfProperty()
static
getFieldRdfProperty(field
):null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:178
Parameters
field
string
Returns
null
| string
Inherited from
Model.getFieldRdfProperty
getFinalEngine()
static
getFinalEngine():undefined
|Engine
Defined in: packages/soukai/src/models/Model.ts:216
Returns
undefined
| Engine
Inherited from
Model.getFinalEngine
getRdfPropertyField()
static
getRdfPropertyField(rdfProperty
):null
|string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:188
Parameters
rdfProperty
string
Returns
null
| string
Inherited from
Model.getRdfPropertyField
hasAutomaticTimestamp()
static
hasAutomaticTimestamp(timestamp
):boolean
Defined in: packages/soukai/src/models/Model.ts:204
Parameters
timestamp
Returns
boolean
Inherited from
Model.hasAutomaticTimestamp
hasAutomaticTimestamps()
static
hasAutomaticTimestamps():boolean
Defined in: packages/soukai/src/models/Model.ts:208
Returns
boolean
Inherited from
Model.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
Model.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
>
Inherited from
Model.newFromJsonLD
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
Model.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
Model.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
>
Inherited from
Model.performSchemaUpdate
prepareEngineFilters()
static
prepareEngineFilters(filters
):EngineFilters
Defined in: packages/soukai-solid/src/models/SolidModel.ts:400
Parameters
filters
EngineFilters
= {}
Returns
Inherited from
Model.prepareEngineFilters
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
Model.pureInstance
rdfTerm()
static
rdfTerm(property
,rdfContexts?
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:409
Parameters
property
string
rdfContexts?
Returns
string
Inherited from
Model.rdfTerm
replaceRdfPrefixes()
static
replaceRdfPrefixes(replacements
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:295
Parameters
replacements
Record
<string
, string
>
Returns
void
Inherited from
Model.replaceRdfPrefixes
requireEngine()
static
requireEngine<T
>():T
Defined in: packages/soukai/src/models/Model.ts:222
Type Parameters
T
Returns
T
Inherited from
Model.requireEngine
requireFetch()
static
requireFetch():Fetch
Defined in: packages/soukai-solid/src/models/SolidModel.ts:204
Returns
Fetch
Inherited from
Model.requireFetch
requireFieldRdfProperty()
static
requireFieldRdfProperty(field
):string
Defined in: packages/soukai-solid/src/models/SolidModel.ts:212
Parameters
field
string
Returns
string
Inherited from
Model.requireFieldRdfProperty
requireFinalEngine()
static
requireFinalEngine<T
>():T
Defined in: packages/soukai/src/models/Model.ts:226
Type Parameters
T
Returns
T
Inherited from
Model.requireFinalEngine
resetRdfAliases()
static
resetRdfAliases():void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:283
Returns
void
Inherited from
Model.resetRdfAliases
setEngine()
static
setEngine(engine?
):void
Defined in: packages/soukai/src/models/Model.ts:230
Parameters
engine?
Returns
void
Inherited from
Model.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
>
Inherited from
Model.synchronize
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
>
Inherited from
Model.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
>
Inherited from
Model.updateSchema
useSoftDeletes()
static
useSoftDeletes(enabled
):void
Defined in: packages/soukai-solid/src/models/SolidModel.ts:220
Parameters
enabled
boolean
Returns
void
Inherited from
Model.useSoftDeletes
usingSolidEngine()
static
usingSolidEngine():boolean
Defined in: packages/soukai-solid/src/models/SolidModel.ts:216
Returns
boolean
Inherited from
Model.usingSolidEngine
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
Model.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
Model.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
Model.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
Model.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
Model.withoutTimestamps