Class: SolidModel

Defined in: packages/soukai-solid/src/models/SolidModel.ts:124

Extends

• SolidModelBase

Constructors

Constructor

new SolidModel(attributes, exists): SolidModel

Defined in: packages/soukai/src/models/Model.ts:486

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:477

Inherited from

SolidModelBase._attributes

---

_dirtyAttributes

protected _dirtyAttributes: Attributes

Defined in: packages/soukai/src/models/Model.ts:479

Inherited from

SolidModelBase._dirtyAttributes

---

_documentExists

protected _documentExists: boolean

Defined in: packages/soukai-solid/src/models/SolidModel.ts:689

---

_exists

protected _exists: boolean

Defined in: packages/soukai/src/models/Model.ts:474

Inherited from

SolidModelBase._exists

---

_malformedDocumentAttributes

protected _malformedDocumentAttributes: Record<string, string[]>

Defined in: packages/soukai/src/models/Model.ts:480

Inherited from

SolidModelBase._malformedDocumentAttributes

---

_originalAttributes

protected _originalAttributes: Attributes

Defined in: packages/soukai/src/models/Model.ts:478

Inherited from

SolidModelBase._originalAttributes

---

_proxy

protected _proxy: SolidModel

Defined in: packages/soukai/src/models/Model.ts:476

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:694

Overrides

SolidModelBase._relations

---

_removedResourceUrls

protected _removedResourceUrls: string[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:692

---

_sourceDocumentUrl

protected _sourceDocumentUrl: null | string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:690

---

_trackedDirtyAttributes

protected _trackedDirtyAttributes: Attributes

Defined in: packages/soukai-solid/src/models/SolidModel.ts:691

---

_usesRdfAliases

protected _usesRdfAliases: boolean

Defined in: packages/soukai-solid/src/models/SolidModel.ts:693

---

_wasRecentlyCreated

protected _wasRecentlyCreated: boolean

Defined in: packages/soukai/src/models/Model.ts:475

Inherited from

SolidModelBase._wasRecentlyCreated

---

authorizations?

optional authorizations: SolidACLAuthorization[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:680

---

deletedAt?

optional deletedAt: Date

Defined in: packages/soukai-solid/src/models/SolidModel.ts:679

---

id

id: string

Defined in: packages/soukai/src/models/Model.ts:473

Inherited from

SolidModelBase.id

---

metadata

metadata: Metadata

Defined in: packages/soukai-solid/src/models/SolidModel.ts:681

---

operations

operations: Operation[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:682

---

relatedAuthorizations

relatedAuthorizations: SolidACLAuthorizationsRelation<SolidModel>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:684

---

relatedMetadata

relatedMetadata: SolidHasOneRelation<SolidModel, Metadata, SolidModelConstructor<Metadata>>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:685

---

relatedOperations

relatedOperations: OperationsRelation<SolidModel>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:686

---

relatedTombstone

relatedTombstone: TombstoneRelation<SolidModel>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:687

---

tombstone?

optional tombstone: Tombstone

Defined in: packages/soukai-solid/src/models/SolidModel.ts:683

---

url

url: string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:677

---

__attributeGetters

static __attributeGetters: Map<string, () => unknown>

Defined in: packages/soukai/src/models/Model.ts:66

Inherited from

SolidModelBase.__attributeGetters

---

__attributeSetters

static __attributeSetters: Map<string, (value) => void>

Defined in: packages/soukai/src/models/Model.ts:67

Inherited from

SolidModelBase.__attributeSetters

---

__isSchema?

static optional __isSchema: boolean

Defined in: packages/soukai-solid/src/models/SolidModel.ts:140

---

classFields

static classFields: string[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:128

Overrides

SolidModelBase.classFields

---

collection

static collection: string

Defined in: packages/soukai/src/models/Model.ts:58

Inherited from

SolidModelBase.collection

---

defaultResourceHash

static defaultResourceHash: null | string = 'it'

Defined in: packages/soukai-solid/src/models/SolidModel.ts:135

---

fields

static fields: SolidFieldsDefinition

Defined in: packages/soukai-solid/src/models/SolidModel.ts:127

Overrides

SolidModelBase.fields

---

history

static history: boolean = false

Defined in: packages/soukai-solid/src/models/SolidModel.ts:138

---

historyDisabled

protected static historyDisabled: WeakMap<SolidModel, void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:143

---

hooks

static hooks: Partial = {}

Defined in: packages/soukai/src/models/Model.ts:65

Inherited from

SolidModelBase.hooks

---

mintsUrls

static mintsUrls: boolean = true

Defined in: packages/soukai-solid/src/models/SolidModel.ts:137

---

modelName

static modelName: string

Defined in: packages/soukai/src/models/Model.ts:62

Inherited from

SolidModelBase.modelName

---

primaryKey

static primaryKey: string = 'url'

Defined in: packages/soukai-solid/src/models/SolidModel.ts:126

Overrides

SolidModelBase.primaryKey

---

rdfContext?

static optional rdfContext: string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:129

---

rdfContexts

static rdfContexts: RDFContexts = {}

Defined in: packages/soukai-solid/src/models/SolidModel.ts:130

---

rdfPropertyFields?

protected static optional rdfPropertyFields: Record<string, string>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:142

---

rdfsClass?

static optional rdfsClass: string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:131

---

rdfsClasses

static rdfsClasses: string[] = []

Defined in: packages/soukai-solid/src/models/SolidModel.ts:132

---

rdfsClassesAliases

static rdfsClassesAliases: string[][] = []

Defined in: packages/soukai-solid/src/models/SolidModel.ts:133

---

relations

static relations: string[] = []

Defined in: packages/soukai/src/models/Model.ts:64

Inherited from

SolidModelBase.relations

---

reservedRelations

static reservedRelations: string[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:134

---

slugField?

static optional slugField: string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:136

---

timestamps

static timestamps: TimestampsDefinition

Defined in: packages/soukai/src/models/Model.ts:60

Inherited from

SolidModelBase.timestamps

---

tombstone

static tombstone: boolean = true

Defined in: packages/soukai-solid/src/models/SolidModel.ts:139

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:342

Parameters

this

TracksHistoryThis

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:220

Parameters

this

TracksHistoryThis

Returns

Promise<void>

Inherited from

SolidModelBase.addDirtyHistoryOperations

---

addHistoryOperations()

addHistoryOperations(this, operations): void

Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:166

Parameters

this

TracksHistoryThis

operations

Operation[]

Returns

void

Inherited from

SolidModelBase.addHistoryOperations

---

afterSave()

protected afterSave(ignoreRelations?): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1385

Parameters

ignoreRelations?

boolean

Returns

Promise<void>

Overrides

SolidModelBase.afterSave

---

attributeValueChanged()

protected attributeValueChanged(originalValue, newValue): boolean

Defined in: packages/soukai/src/models/Model.ts:1281

Parameters

originalValue

unknown

newValue

unknown

Returns

boolean

Inherited from

SolidModelBase.attributeValueChanged

---

authorizationsRelationship()

authorizationsRelationship(): Relation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1176

Returns

Relation

---

beforeCreate()

protected beforeCreate(): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1316

Returns

Promise<void>

---

beforeDocumentSave()

protected beforeDocumentSave(): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1292

Returns

Promise<void>

---

beforeSave()

protected beforeSave(ignoreRelations?): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1274

Parameters

ignoreRelations?

boolean

Returns

Promise<void>

Overrides

SolidModelBase.beforeSave

---

beforeUpdate()

protected beforeUpdate(): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1336

Returns

Promise<void>

---

belongsToMany()

Call Signature

protected belongsToMany<T>(relatedClass, foreignKeyField?, localKeyField?): SolidBelongsToManyRelation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1547

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

SolidBelongsToManyRelation

Overrides

SolidModelBase.belongsToMany

Call Signature

protected belongsToMany<T>(relatedClass, foreignKeyField?, localKeyField?): Relation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1553

Type Parameters

T

T extends typeof Model

Parameters

relatedClass

T

foreignKeyField?

string

localKeyField?

string

Returns

Relation

Overrides

SolidModelBase.belongsToMany

---

belongsToOne()

Call Signature

protected belongsToOne<T>(relatedClass, foreignKeyField?, localKeyField?): SolidBelongsToOneRelation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1525

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

SolidBelongsToOneRelation

Overrides

SolidModelBase.belongsToOne

Call Signature

protected belongsToOne<T>(relatedClass, foreignKeyField?, localKeyField?): Relation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1531

Type Parameters

T

T extends typeof Model

Parameters

relatedClass

T

foreignKeyField?

string

localKeyField?

string

Returns

Relation

Overrides

SolidModelBase.belongsToOne

---

callAttributeGetter()

callAttributeGetter(field): unknown

Defined in: packages/soukai/src/models/Model.ts:802

Parameters

field

string

Returns

unknown

Inherited from

SolidModelBase.callAttributeGetter

---

callAttributeSetter()

callAttributeSetter(field, value): void

Defined in: packages/soukai/src/models/Model.ts:706

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:1666

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:1291

Parameters

attributes

Attributes

definitions

BootedFieldsDefinition

malformedAttributes?

Record<string, string[]>

fieldPrefix?

string = ''

Returns

Attributes

Inherited from

SolidModelBase.castAttributes

---

cleanDirty()

cleanDirty(ignoreRelations?): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:904

Parameters

ignoreRelations?

boolean

Returns

void

Overrides

SolidModelBase.cleanDirty

---

clone()

Call Signature

clone(options?): this

Defined in: packages/soukai/src/models/Model.ts:919

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:920

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

EngineFilters

compactIRIs

boolean

Returns

EngineFilters

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

EngineUpdates

compactIRIs

boolean

Returns

EngineUpdates

Inherited from

SolidModelBase.convertEngineUpdatesToJsonLD

---

createFromEngineDocument()

protected createFromEngineDocument(id, document, resourceId?): Promise<SolidModel>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1194

Parameters

id

Key

document

EngineDocument

resourceId?

string

Returns

Promise<SolidModel>

Overrides

SolidModelBase.createFromEngineDocument

---

createManyFromEngineDocuments()

protected createManyFromEngineDocuments(documents): Promise<SolidModel[]>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1221

Parameters

documents

Record<string, EngineDocument>

Returns

Promise<SolidModel[]>

Overrides

SolidModelBase.createManyFromEngineDocuments

---

delete()

delete(): Promise<SolidModel>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:783

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:1476

Parameters

models

SolidModel[]

Returns

Promise<void>

Overrides

SolidModelBase.deleteModelsFromEngine

---

disableHistory()

disableHistory(): void

Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:104

Returns

void

Inherited from

SolidModelBase.disableHistory

---

disableTombstone()

disableTombstone(): void

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

Returns

void

Inherited from

SolidModelBase.disableTombstone

---

documentContainsMany()

protected documentContainsMany<T>(model): DocumentContainsManyRelation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1572

Type Parameters

T

T extends typeof SolidModel

Parameters

model

T

Returns

DocumentContainsManyRelation

---

documentExists()

documentExists(): boolean

Defined in: packages/soukai-solid/src/models/SolidModel.ts:867

Returns

boolean

---

emit()

protected emit<T>(...args): Promise<void>

Defined in: packages/soukai/src/models/Model.ts:1137

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:100

Returns

void

Inherited from

SolidModelBase.enableHistory

---

enableTombstone()

enableTombstone(): void

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

Returns

void

Inherited from

SolidModelBase.enableTombstone

---

exists()

exists(): boolean

Defined in: packages/soukai/src/models/Model.ts:907

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:939

Returns

void

Overrides

SolidModelBase.fixMalformedAttributes

---

fresh()

fresh(): Promise<SolidModel>

Defined in: packages/soukai/src/models/Model.ts:521

Returns

Promise<SolidModel>

Inherited from

SolidModelBase.fresh

---

getAttribute()

getAttribute<T>(field, includeUndefined): T

Defined in: packages/soukai/src/models/Model.ts:771

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:792

Parameters

includeUndefined

boolean = false

Returns

Attributes

Inherited from

SolidModelBase.getAttributes

---

getAttributeValue()

getAttributeValue<T>(field, includeUndefined): T

Defined in: packages/soukai/src/models/Model.ts:777

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:1158

Returns

Promise<Model[]>

Inherited from

SolidModelBase.getCascadeModels

---

getContainerUrl()

getContainerUrl(): null | string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:984

Returns

null | string

---

getCreatedAtAttribute()

getCreatedAtAttribute(): Date

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1020

Returns

Date

---

getDefaultCollection()

protected getDefaultCollection(): string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1188

Returns

string

Overrides

SolidModelBase.getDefaultCollection

---

getDeletedAtAttribute()

getDeletedAtAttribute(): undefined | Date

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1028

Returns

undefined | Date

---

getDeletedPrimaryKey()

getDeletedPrimaryKey(): null | Key

Defined in: packages/soukai/src/models/Model.ts:716

Returns

null | Key

Inherited from

SolidModelBase.getDeletedPrimaryKey

---

getDirtyDocumentModels()

getDirtyDocumentModels(): SolidModel[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1095

Returns

SolidModel[]

---

getDirtyEngineDocumentUpdates()

protected getDirtyEngineDocumentUpdates(ignoreRelations?): EngineUpdates

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1588

Parameters

ignoreRelations?

boolean

Returns

EngineUpdates

Overrides

SolidModelBase.getDirtyEngineDocumentUpdates

---

getDocumentModels()

getDocumentModels(_documentModels?): SolidModel[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1032

Parameters

_documentModels?

Set<SolidModel>

Returns

SolidModel[]

---

getDocumentUrl()

getDocumentUrl(): null | string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:960

Returns

null | string

---

getEngine()

getEngine(): undefined | Engine

Defined in: packages/soukai/src/models/Model.ts:559

Returns

undefined | Engine

Inherited from

SolidModelBase.getEngine

---

getFinalEngine()

getFinalEngine(): undefined | Engine

Defined in: packages/soukai/src/models/Model.ts:563

Returns

undefined | Engine

Inherited from

SolidModelBase.getFinalEngine

---

getHistoryHash()

getHistoryHash(this): null | string

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

Parameters

this

TracksHistoryThis

Returns

null | string

Inherited from

SolidModelBase.getHistoryHash

---

getIdAttribute()

getIdAttribute(): string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:857

Returns

string

---

getMalformedDocumentAttributes()

getMalformedDocumentAttributes(): Record<string, string[]>

Defined in: packages/soukai/src/models/Model.ts:735

Returns

Record<string, string[]>

Inherited from

SolidModelBase.getMalformedDocumentAttributes

---

getMetadataSchemaUpdates()

protected getMetadataSchemaUpdates(this, dirtyUrl): EngineAttributeUpdateOperation[]

Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:199

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:109

Parameters

this

SolidModel

model

SolidModel

removedFields

string[]

dirtyUrl

Nullable<string>

options

MigrateSchemaOptions

Returns

Promise<EngineAttributeUpdateOperation[]>

Inherited from

SolidModelBase.getOperationSchemaUpdates

---

getOperationValue()

protected getOperationValue(this, field, value): unknown

Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:326

Parameters

this

TracksHistoryThis

field

string

value

unknown

Returns

unknown

Inherited from

SolidModelBase.getOperationValue

---

getOriginalAttribute()

getOriginalAttribute<T>(field): T

Defined in: packages/soukai/src/models/Model.ts:712

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:852

Returns

null | Key

Inherited from

SolidModelBase.getPrimaryKey

---

getRelatedModels()

getRelatedModels(_relatedModels?): SolidModel[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1125

Parameters

_relatedModels?

Set<SolidModel>

Returns

SolidModel[]

---

getRelation()

getRelation<T>(relation): null | T

Defined in: packages/soukai/src/models/Model.ts:549

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:1105

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:1106

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:1111

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:1112

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:1076

Returns

SolidModel[]

---

getResourceSchemaUpdate()

protected getResourceSchemaUpdate(this, model, dirtyUrl?): EngineAttributeUpdateOperation

Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:233

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

SolidModelConstructor<T>

options

MigrateSchemaOptions

Returns

Promise<{ model: T; updates: EngineAttributeUpdateOperation[]; }>

Inherited from

SolidModelBase.getSchemaUpdates

---

getSerializedPrimaryKey()

getSerializedPrimaryKey(): null | string

Defined in: packages/soukai/src/models/Model.ts:856

Returns

null | string

Inherited from

SolidModelBase.getSerializedPrimaryKey

---

getSourceContainerUrl()

getSourceContainerUrl(): null | string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:990

Returns

null | string

---

getSourceDocumentUrl()

getSourceDocumentUrl(): null | string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:972

Returns

null | string

---

getUpdatedAtAttribute()

getUpdatedAtAttribute(): Date

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1024

Returns

Date

---

getUrlSchemaUpdates()

protected getUrlSchemaUpdates(this, dirtyUrl): EngineAttributeUpdateOperation[]

Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:218

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:1731

Returns

undefined | string

---

hasAttribute()

hasAttribute(field): boolean

Defined in: packages/soukai/src/models/Model.ts:666

Parameters

field

string

Returns

boolean

Inherited from

SolidModelBase.hasAttribute

---

hasAttributeGetter()

hasAttributeGetter(field): boolean

Defined in: packages/soukai/src/models/Model.ts:798

Parameters

field

string

Returns

boolean

Inherited from

SolidModelBase.hasAttributeGetter

---

hasAttributeSetter()

hasAttributeSetter(field): boolean

Defined in: packages/soukai/src/models/Model.ts:702

Parameters

field

string

Returns

boolean

Inherited from

SolidModelBase.hasAttributeSetter

---

hasIncompleteAttributes()

hasIncompleteAttributes(): boolean

Defined in: packages/soukai/src/models/Model.ts:822

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:1503

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

SolidHasManyRelation

Overrides

SolidModelBase.hasMany

Call Signature

protected hasMany<T>(relatedClass, foreignKeyField?, localKeyField?): Relation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1509

Type Parameters

T

T extends typeof Model

Parameters

relatedClass

T

foreignKeyField?

string

localKeyField?

string

Returns

Relation

Overrides

SolidModelBase.hasMany

---

hasOne()

Call Signature

protected hasOne<T>(relatedClass, foreignKeyField?, localKeyField?): SolidHasOneRelation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1481

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

SolidHasOneRelation

Overrides

SolidModelBase.hasOne

Call Signature

protected hasOne<T>(relatedClass, foreignKeyField?, localKeyField?): Relation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1487

Type Parameters

T

T extends typeof Model

Parameters

relatedClass

T

foreignKeyField?

string

localKeyField?

string

Returns

Relation

Overrides

SolidModelBase.hasOne

---

hasRelation()

hasRelation(relation): boolean

Defined in: packages/soukai/src/models/Model.ts:545

Parameters

relation

string

Returns

boolean

Inherited from

SolidModelBase.hasRelation

---

ignoreRdfPropertyHistory()

ignoreRdfPropertyHistory(rdfProperty, withSolidEngine?): boolean

Defined in: packages/soukai-solid/src/models/SolidModel.ts:956

Parameters

rdfProperty

string

withSolidEngine?

boolean

Returns

boolean

---

initialize()

protected initialize(attributes, exists): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:699

Parameters

attributes

Attributes

exists

boolean

Returns

void

Overrides

SolidModelBase.initialize

---

initializeAttributes()

protected initializeAttributes(attributes, exists): void

Defined in: packages/soukai/src/models/Model.ts:1017

Parameters

attributes

Attributes

exists

boolean

Returns

void

Inherited from

SolidModelBase.initializeAttributes

---

initializeMetadataRelation()

protected initializeMetadataRelation(): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:729

Returns

void

---

initializeProxy()

protected initializeProxy(): void

Defined in: packages/soukai/src/models/Model.ts:957

Returns

void

Inherited from

SolidModelBase.initializeProxy

---

initializeRelations()

protected initializeRelations(): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:709

Returns

void

Overrides

SolidModelBase.initializeRelations

---

initializeRelationsEnabling()

protected initializeRelationsEnabling(): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:716

Returns

void

---

is()

is(another): boolean

Defined in: packages/soukai/src/models/Model.ts:832

Parameters

another

this

Returns

boolean

Inherited from

SolidModelBase.is

---

isContainedBy()

protected isContainedBy<T>(model): SolidIsContainedByRelation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1568

Type Parameters

T

T extends typeof SolidContainer

Parameters

model

T

Returns

SolidIsContainedByRelation

---

isDirty()

isDirty(field?, ignoreRelations?): boolean

Defined in: packages/soukai-solid/src/models/SolidModel.ts:882

Parameters

field?

string

ignoreRelations?

boolean

Returns

boolean

Overrides

SolidModelBase.isDirty

---

isRelationLoaded()

isRelationLoaded(relation): boolean

Defined in: packages/soukai/src/models/Model.ts:662

Parameters

relation

string

Returns

boolean

Inherited from

SolidModelBase.isRelationLoaded

---

isSoftDeleted()

isSoftDeleted(): boolean

Defined in: packages/soukai-solid/src/models/SolidModel.ts:900

Returns

boolean

---

leavesTombstone()

leavesTombstone(this): boolean

Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:116

Parameters

this

TracksHistoryThis

Returns

boolean

Inherited from

SolidModelBase.leavesTombstone

---

loadDocumentModels()

protected loadDocumentModels(documentUrl, document): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1257

Parameters

documentUrl

string

document

EngineDocument

Returns

Promise<void>

---

loadEmptyRelations()

protected loadEmptyRelations(): Promise<void>

Defined in: packages/soukai/src/models/Model.ts:1253

Returns

Promise<void>

Inherited from

SolidModelBase.loadEmptyRelations

---

loadRelation()

loadRelation<T>(relation): Promise<T>

Defined in: packages/soukai/src/models/Model.ts:577

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:587

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:1287

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:1160

Returns

Relation

---

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:1737

Parameters

models

SolidModel[]

Returns

void

---

mintUrl()

mintUrl(documentUrl?, documentExists?, resourceHash?): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:813

Parameters

documentUrl?

string

documentExists?

boolean

resourceHash?

string

Returns

void

---

newInstance()

newInstance<T>(this, ...params): T

Defined in: packages/soukai/src/models/Model.ts:515

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:61

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModel

schema

SolidModelConstructor<T>

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:1722

Parameters

url?

string

Returns

string

---

newUrl()

protected newUrl(documentUrl?, resourceHash?): string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1698

Parameters

documentUrl?

string

resourceHash?

null | string

Returns

string

---

newUrlDocumentUrl()

protected newUrlDocumentUrl(): string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1705

Returns

string

---

newUrlDocumentUrlSlug()

protected newUrlDocumentUrlSlug(): null | string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1711

Returns

null | string

---

newUrlResourceHash()

protected newUrlResourceHash(): null | string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1718

Returns

null | string

---

onMoved()

onMoved(newResourceUrl, newDocumentUrl?): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1180

Parameters

newResourceUrl

string

newDocumentUrl?

string

Returns

void

---

onPrimaryKeyUpdated()

protected onPrimaryKeyUpdated(value, oldValue): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1403

Parameters

value

null | Key

oldValue

null | Key

Returns

void

---

operationsRelationship()

operationsRelationship(): Relation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1168

Returns

Relation

---

parseEngineDocumentAttributes()

protected parseEngineDocumentAttributes(id, document, resourceId?): Promise<Attributes>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1658

Parameters

id

Key

document

EngineDocument

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

EngineDocument

resourceId

string

Returns

Promise<Attributes>

Inherited from

SolidModelBase.parseEngineDocumentAttributesFromJsonLD

---

parseKey()

protected parseKey(key): Key

Defined in: packages/soukai/src/models/Model.ts:1436

Parameters

key

string

Returns

Key

Inherited from

SolidModelBase.parseKey

---

performDelete()

protected performDelete(): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1377

Returns

Promise<void>

Overrides

SolidModelBase.performDelete

---

performMalformedAttributeFixes()

protected performMalformedAttributeFixes(): void

Defined in: packages/soukai/src/models/Model.ts:1118

Returns

void

Inherited from

SolidModelBase.performMalformedAttributeFixes

---

performSave()

protected performSave(): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1356

Returns

Promise<void>

Overrides

SolidModelBase.performSave

---

rebuildAttributesFromHistory()

rebuildAttributesFromHistory(this): void

Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:130

Parameters

this

TracksHistoryThis

Returns

void

Inherited from

SolidModelBase.rebuildAttributesFromHistory

---

reconcileModelTimestamps()

protected reconcileModelTimestamps(this, wasTouchedBeforeSaving): void

Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:370

Parameters

this

TracksHistoryThis

wasTouchedBeforeSaving

boolean

Returns

void

Inherited from

SolidModelBase.reconcileModelTimestamps

---

registerInTypeIndex()

registerInTypeIndex(typeIndexUrl): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:806

Parameters

typeIndexUrl

string

Returns

Promise<void>

---

removeDuplicatedHistoryOperations()

protected removeDuplicatedHistoryOperations(this): void

Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:298

Parameters

this

TracksHistoryThis

Returns

void

Inherited from

SolidModelBase.removeDuplicatedHistoryOperations

---

requireContainerUrl()

requireContainerUrl(): string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:980

Returns

string

---

requireDocumentUrl()

requireDocumentUrl(): string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:964

Returns

string

---

requireEngine()

requireEngine<T>(): T

Defined in: packages/soukai/src/models/Model.ts:569

Type Parameters

T

T extends Engine

Returns

T

Inherited from

SolidModelBase.requireEngine

---

requireFinalEngine()

requireFinalEngine<T>(): T

Defined in: packages/soukai/src/models/Model.ts:573

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:1099

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:1100

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:846

Returns

void

Inherited from

SolidModelBase.reset

---

resetEngineData()

protected resetEngineData(): void

Defined in: packages/soukai/src/models/Model.ts:1185

Returns

void

Deprecated

use reset instead.

Inherited from

SolidModelBase.resetEngineData

---

save()

save(collection?): Promise<SolidModel>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:765

Parameters

collection?

string

Returns

Promise<SolidModel>

Overrides

SolidModelBase.save

---

saveInDocument()

saveInDocument(documentUrl, resourceHash?): Promise<SolidModel>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:769

Parameters

documentUrl

string

resourceHash?

string

Returns

Promise<SolidModel>

---

serializeKey()

protected serializeKey(key): string

Defined in: packages/soukai/src/models/Model.ts:1432

Parameters

key

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:996

Parameters

field

string

value

unknown

Returns

void

Overrides

SolidModelBase.setAttribute

---

setAttributes()

setAttributes(attributes): void

Defined in: packages/soukai/src/models/Model.ts:729

Parameters

attributes

Attributes

Returns

void

Inherited from

SolidModelBase.setAttributes

---

setAttributeValue()

setAttributeValue(field, value): void

Defined in: packages/soukai/src/models/Model.ts:692

Parameters

field

string

value

unknown

Returns

void

Inherited from

SolidModelBase.setAttributeValue

---

setCreatedAtAttribute()

setCreatedAtAttribute(value): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1012

Parameters

value

unknown

Returns

void

---

setDocumentExists()

setDocumentExists(documentExists): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:871

Parameters

documentExists

boolean

Returns

void

---

setEngine()

setEngine(engine?): void

Defined in: packages/soukai/src/models/Model.ts:743

Parameters

engine?

Engine

Returns

void

Inherited from

SolidModelBase.setEngine

---

setExists()

setExists(exists): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:861

Parameters

exists

boolean

Returns

void

Overrides

SolidModelBase.setExists

---

setMalformedDocumentAttributes()

setMalformedDocumentAttributes(malformedAttributes): void

Defined in: packages/soukai/src/models/Model.ts:739

Parameters

malformedAttributes

Record<string, string[]>

Returns

void

Inherited from

SolidModelBase.setMalformedDocumentAttributes

---

setOriginalAttribute()

setOriginalAttribute(field, value): void

Defined in: packages/soukai/src/models/Model.ts:720

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:1117

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:1121

Parameters

relation

string

models

null | SolidModel[]

Returns

void

Overrides

SolidModelBase.setRelationModels

---

setSourceDocumentUrl()

setSourceDocumentUrl(sourceDocumentUrl): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:976

Parameters

sourceDocumentUrl

null | string

Returns

void

---

setUpdatedAtAttribute()

setUpdatedAtAttribute(value): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1016

Parameters

value

unknown

Returns

void

---

softDelete()

softDelete(): Promise<SolidModel>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:787

Returns

Promise<SolidModel>

---

static()

Call Signature

static(property): SolidBootedFieldsDefinition

Defined in: packages/soukai-solid/src/models/SolidModel.ts:753

Parameters

property

"fields"

Returns

SolidBootedFieldsDefinition

Overrides

SolidModelBase.static

Call Signature

static(property): TimestampFieldValue[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:754

Parameters

property

"timestamps"

Returns

TimestampFieldValue[]

Overrides

SolidModelBase.static

Call Signature

static<T>(): T

Defined in: packages/soukai-solid/src/models/SolidModel.ts:755

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:756

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:1430

Returns

Promise<string>

Overrides

SolidModelBase.syncDirty

---

toEngineDocument()

protected toEngineDocument(): EngineDocument

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1576

Returns

EngineDocument

Overrides

SolidModelBase.toEngineDocument

---

toJsonLD()

toJsonLD(options): Record<string, unknown>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:821

Parameters

options

SolidModelSerializationOptions = {}

Returns

Record<string, unknown>

---

tombstoneRelationship()

tombstoneRelationship(): Relation

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1172

Returns

Relation

---

toTurtle()

toTurtle(options): Promise<string>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:851

Parameters

options

SolidModelSerializationOptions = {}

Returns

Promise<string>

---

touch()

touch(): void

Defined in: packages/soukai/src/models/Model.ts:899

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

PermissionsTracker

Inherited from

SolidModelBase.trackPublicPermissions

---

tracksHistory()

tracksHistory(this): boolean

Defined in: packages/soukai-solid/src/models/mixins/TracksHistory.ts:74

Parameters

this

TracksHistoryThis

Returns

boolean

Inherited from

SolidModelBase.tracksHistory

---

unloadRelation()

unloadRelation(relation): void

Defined in: packages/soukai/src/models/Model.ts:595

Parameters

relation

string

Returns

void

Inherited from

SolidModelBase.unloadRelation

---

unsetAttribute()

unsetAttribute(field): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1006

Parameters

field

string

Returns

void

Overrides

SolidModelBase.unsetAttribute

---

update()

update(attributes?): Promise<SolidModel>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:761

Parameters

attributes?

Attributes

Returns

Promise<SolidModel>

Overrides

SolidModelBase.update

---

updateEngineDocumentSchema()

protected updateEngineDocumentSchema(this, graphUpdates): Promise<void>

Defined in: packages/soukai-solid/src/models/mixins/MigratesSchemas.ts:249

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:968

Returns

boolean

---

usingSolidEngine()

usingSolidEngine(): boolean

Defined in: packages/soukai-solid/src/models/SolidModel.ts:1156

Returns

boolean

---

wasRecentlyCreated()

wasRecentlyCreated(): boolean

Defined in: packages/soukai/src/models/Model.ts:911

Returns

boolean

Inherited from

SolidModelBase.wasRecentlyCreated

---

wasRecentlyDeleted()

wasRecentlyDeleted(): boolean

Defined in: packages/soukai/src/models/Model.ts:915

Returns

boolean

Inherited from

SolidModelBase.wasRecentlyDeleted

---

withEngine()

Call Signature

withEngine(engine): this

Defined in: packages/soukai/src/models/Model.ts:753

Parameters

engine

Engine

Returns

this

Inherited from

SolidModelBase.withEngine

Call Signature

withEngine<T>(engine, operation): T

Defined in: packages/soukai/src/models/Model.ts:754

Type Parameters

T

T

Parameters

engine

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:755

Type Parameters

T

T

Parameters

engine

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:765

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:78

Type Parameters

T

T

Parameters

this

TracksHistoryThis

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:79

Type Parameters

T

T

Parameters

this

TracksHistoryThis

operation

() => Promise<T>

Returns

Promise<T>

Inherited from

SolidModelBase.withoutTrackingHistory

---

aliasRdfPrefixes()

static aliasRdfPrefixes(aliases): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:245

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:357

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

filters?

EngineFilters

Returns

Promise<T[]>

Overrides

SolidModelBase.all

Call Signature

static all<T>(this, filters?): Promise<T[]>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:358

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

filters?

EngineFilters

Returns

Promise<T[]>

Overrides

SolidModelBase.all

---

at()

static at<T>(this, parentUrl): SolidModelConstructor<T>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:221

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

parentUrl

string

Returns

SolidModelConstructor<T>

---

boot()

static boot(name?): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:228

Parameters

name?

string

Returns

void

Overrides

SolidModelBase.boot

---

bootClassDefinitions()

protected static bootClassDefinitions(): object

Defined in: packages/soukai/src/models/Model.ts:408

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:588

Returns

string

Overrides

SolidModelBase.bootCollection

---

bootFields()

protected static bootFields(fields, primaryKey, timestamps, fieldDefinitions): object

Defined in: packages/soukai-solid/src/models/SolidModel.ts:602

Parameters

fields

undefined | SolidFieldsDefinition

primaryKey

string

timestamps

TimestampFieldValue[]

fieldDefinitions

SolidBootedFieldsDefinition

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:454

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:297

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:496

Parameters

rdfContext

null | string

rdfContexts

RDFContexts

rdfsClass

undefined | string

options

modelClass?

typeof SolidModel

skipParentSchema?

boolean

Returns

RDFContexts

---

bootRdfsClasses()

protected static bootRdfsClasses(rdfsClass, rdfsClasses, rdfContexts, initialClass?): string[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:548

Parameters

rdfsClass

null | string

rdfsClasses

null | string[]

rdfContexts

RDFContexts

initialClass?

typeof SolidModel

Returns

string[]

---

bootRdfsClassesAliases()

protected static bootRdfsClassesAliases(rdfsClassesAliases, rdfContexts): string[][]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:581

Parameters

rdfsClassesAliases

string[][]

rdfContexts

RDFContexts

Returns

string[][]

---

bootTimestamps()

protected static bootTimestamps(timestamps, fieldDefinitions): TimestampFieldValue[]

Defined in: packages/soukai/src/models/Model.ts:321

Parameters

timestamps

undefined | boolean | TimestampFieldValue[]

fieldDefinitions

BootedFieldsDefinition

Returns

TimestampFieldValue[]

Inherited from

SolidModelBase.bootTimestamps

---

create()

static create<T>(this, attributes): Promise<T>

Defined in: packages/soukai/src/models/Model.ts:123

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

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:300

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

id

Key

document

EngineDocument

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:307

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

id

Key

document

EngineDocument

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:451

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

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:460

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

attributes

Attributes

documentUrl

string

resourceHash?

string

Returns

Promise<T>

---

createManyFromEngineDocuments()

static createManyFromEngineDocuments<T>(this, documents): Promise<T[]>

Defined in: packages/soukai/src/models/Model.ts:137

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

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:109

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

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:323

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

id

Key

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:324

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

id

Key

Returns

Promise<null | T>

Overrides

SolidModelBase.find

---

findMatchingResourceIds()

static findMatchingResourceIds(quads, baseUrl?): string[]

Defined in: packages/soukai-solid/src/models/SolidModel.ts:477

Parameters

quads

Quad[]

baseUrl?

string

Returns

string[]

---

findOrFail()

static findOrFail<T>(this, id): Promise<T>

Defined in: packages/soukai/src/models/Model.ts:144

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

id

Key

Returns

Promise<T>

Inherited from

SolidModelBase.findOrFail

---

first()

static first<T>(this, filters?): Promise<null | T>

Defined in: packages/soukai/src/models/Model.ts:173

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

filters?

EngineFilters

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:212

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

parentUrl

string

Returns

SolidModelConstructor<T>

---

getDefaultRdfContext()

protected static getDefaultRdfContext(rdfContexts?): string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:639

Parameters

rdfContexts?

RDFContexts

Returns

string

---

getEngine()

static getEngine(): undefined | Engine

Defined in: packages/soukai/src/models/Model.ts:211

Returns

undefined | Engine

Inherited from

SolidModelBase.getEngine

---

getFieldDefinition()

static getFieldDefinition(field, value?): SolidBootedFieldDefinition

Defined in: packages/soukai-solid/src/models/SolidModel.ts:145

Parameters

field

string

value?

unknown

Returns

SolidBootedFieldDefinition

---

getFieldRdfProperty()

static getFieldRdfProperty(field): null | string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:170

Parameters

field

string

Returns

null | string

---

getFinalEngine()

static getFinalEngine(): undefined | Engine

Defined in: packages/soukai/src/models/Model.ts:215

Returns

undefined | Engine

Inherited from

SolidModelBase.getFinalEngine

---

getRdfPropertyField()

static getRdfPropertyField(rdfProperty): null | string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:180

Parameters

rdfProperty

string

Returns

null | string

---

hasAutomaticTimestamp()

static hasAutomaticTimestamp(timestamp): boolean

Defined in: packages/soukai/src/models/Model.ts:203

Parameters

timestamp

TimestampFieldValue

Returns

boolean

Inherited from

SolidModelBase.hasAutomaticTimestamp

---

hasAutomaticTimestamps()

static hasAutomaticTimestamps(): boolean

Defined in: packages/soukai/src/models/Model.ts:207

Returns

boolean

Inherited from

SolidModelBase.hasAutomaticTimestamps

---

instance()

static instance<T>(this): T

Defined in: packages/soukai/src/models/Model.ts:195

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

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:402

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

sourceJsonLD

JsonLD

baseUrl?

string

sourceResourceId?

string

Returns

Promise<T>

---

newInstance()

static newInstance<T>(this, ...params): T

Defined in: packages/soukai/src/models/Model.ts:180

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

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:187

Type Parameters

TModel

TModel extends Model

TEvent

TEvent extends keyof ModelEvents | "schema-updated"

Parameters

this

ModelConstructor<TModel>

event

TEvent

listener

ModelListener<TModel, TEvent>

Returns

Function

Returns

void

Inherited from

SolidModelBase.on

---

performSchemaUpdate()

protected static performSchemaUpdate(schema): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:645

Parameters

schema

SolidSchemaDefinition | SolidModelConstructor

Returns

Promise<void>

Overrides

SolidModelBase.performSchemaUpdate

---

prepareEngineFilters()

static prepareEngineFilters(filters): EngineFilters

Defined in: packages/soukai-solid/src/models/SolidModel.ts:381

Parameters

filters

EngineFilters = {}

Returns

EngineFilters

---

pureInstance()

protected static pureInstance<T>(this): T

Defined in: packages/soukai/src/models/Model.ts:289

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

Returns

T

Inherited from

SolidModelBase.pureInstance

---

rdfTerm()

static rdfTerm(property, rdfContexts?): string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:390

Parameters

property

string

rdfContexts?

RDFContexts

Returns

string

---

replaceRdfPrefixes()

static replaceRdfPrefixes(replacements): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:283

Parameters

replacements

Record<string, string>

Returns

void

---

requireEngine()

static requireEngine<T>(): T

Defined in: packages/soukai/src/models/Model.ts:221

Type Parameters

T

T extends Engine = Engine

Returns

T

Inherited from

SolidModelBase.requireEngine

---

requireFetch()

static requireFetch(): Fetch

Defined in: packages/soukai-solid/src/models/SolidModel.ts:196

Returns

Fetch

---

requireFieldRdfProperty()

static requireFieldRdfProperty(field): string

Defined in: packages/soukai-solid/src/models/SolidModel.ts:204

Parameters

field

string

Returns

string

---

requireFinalEngine()

static requireFinalEngine<T>(): T

Defined in: packages/soukai/src/models/Model.ts:225

Type Parameters

T

T extends Engine = Engine

Returns

T

Inherited from

SolidModelBase.requireFinalEngine

---

resetRdfAliases()

static resetRdfAliases(): void

Defined in: packages/soukai-solid/src/models/SolidModel.ts:271

Returns

void

---

setEngine()

static setEngine(engine?): void

Defined in: packages/soukai/src/models/Model.ts:229

Parameters

engine?

Engine

Returns

void

Inherited from

SolidModelBase.setEngine

---

synchronize()

static synchronize<T>(this, a, b): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:469

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

a

T

b

T

Returns

Promise<void>

---

updateSchema()

Call Signature

static updateSchema(schema): Promise<void>

Defined in: packages/soukai-solid/src/models/SolidModel.ts:188

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:189

Parameters

schema

Partial<{ fields: FieldsDefinition<unknown>; hooks: Partial<Record<"beforeSave" | "afterSave", (this) => void | Promise<void>>>; primaryKey: string; timestamps: TimestampsDefinition; }> | ModelConstructor

Returns

Promise<void>

Overrides

SolidModelBase.updateSchema

---

usingSolidEngine()

static usingSolidEngine(): boolean

Defined in: packages/soukai-solid/src/models/SolidModel.ts:208

Returns

boolean

---

withCollection()

static withCollection<Result>(collection, operation?): Promise<Result>

Defined in: packages/soukai/src/models/Model.ts:255

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:239

Type Parameters

T

T

Parameters

this

T

engine

Engine

Returns

T

Inherited from

SolidModelBase.withEngine

Call Signature

static withEngine<T>(engine, operation): T

Defined in: packages/soukai/src/models/Model.ts:240

Type Parameters

T

T

Parameters

engine

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:241

Type Parameters

T

T

Parameters

engine

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:283

Type Parameters

T

T

Parameters

operation

() => Promise<T>

Returns

Promise<T>

Inherited from

SolidModelBase.withoutTimestamps