Class: SolidModel

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

Extends

• SolidModelBase

Constructors

Constructor

new SolidModel(attributes, _?): SolidModel

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

Parameters

attributes

Attributes = {}

_?

boolean

Returns

SolidModel

Inherited from

SolidModelBase.constructor

Properties

_attributes

protected _attributes: Attributes

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

Inherited from

SolidModelBase._attributes

---

_dirtyAttributes

protected _dirtyAttributes: Attributes

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

Inherited from

SolidModelBase._dirtyAttributes

---

_documentExists

protected _documentExists: boolean

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

---

_exists

protected _exists: boolean

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

Inherited from

SolidModelBase._exists

---

_malformedDocumentAttributes

protected _malformedDocumentAttributes: Record<string, string[]>

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

Inherited from

SolidModelBase._malformedDocumentAttributes

---

_originalAttributes

protected _originalAttributes: Attributes

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

Inherited from

SolidModelBase._originalAttributes

---

_proxy

protected _proxy: SolidModel

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

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

Overrides

SolidModelBase._relations

---

_removedResourceUrls

protected _removedResourceUrls: string[]

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

---

_sourceDocumentUrl

protected _sourceDocumentUrl: null | string

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

---

_trackedDirtyAttributes

protected _trackedDirtyAttributes: Attributes

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

---

_usesRdfAliases

protected _usesRdfAliases: boolean

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

---

_wasRecentlyCreated

protected _wasRecentlyCreated: boolean

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

Inherited from

SolidModelBase._wasRecentlyCreated

---

authorizations?

optional authorizations: SolidACLAuthorization[]

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

---

deletedAt?

optional deletedAt: Date

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

---

id

id: string

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

Inherited from

SolidModelBase.id

---

metadata

metadata: Metadata

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

---

operations

operations: Operation[]

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

---

relatedAuthorizations

relatedAuthorizations: SolidACLAuthorizationsRelation<SolidModel>

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

---

relatedMetadata

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

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

---

relatedOperations

relatedOperations: OperationsRelation<SolidModel>

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

---

relatedTombstone

relatedTombstone: TombstoneRelation<SolidModel>

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

---

tombstone?

optional tombstone: Tombstone

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

---

url

url: string

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

---

__attributeGetters

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

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

Inherited from

SolidModelBase.__attributeGetters

---

__attributeSetters

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

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

Inherited from

SolidModelBase.__attributeSetters

---

__isSchema?

static optional __isSchema: boolean

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

---

classFields

static classFields: string[]

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

Overrides

SolidModelBase.classFields

---

collection

static collection: string

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

Inherited from

SolidModelBase.collection

---

defaultResourceHash

static defaultResourceHash: null | string = 'it'

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

---

fields

static fields: SolidFieldsDefinition

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

Overrides

SolidModelBase.fields

---

history

static history: boolean = false

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

---

historyDisabled

protected static historyDisabled: WeakMap<SolidModel, void>

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

---

hooks

static hooks: ModelHooks = {}

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

Inherited from

SolidModelBase.hooks

---

mintsUrls

static mintsUrls: boolean = true

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

---

modelName

static modelName: string

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

Inherited from

SolidModelBase.modelName

---

primaryKey

static primaryKey: string = 'url'

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

Overrides

SolidModelBase.primaryKey

---

rdfContext?

static optional rdfContext: string

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

---

rdfContexts

static rdfContexts: RDFContexts = {}

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

---

rdfPropertyFields?

protected static optional rdfPropertyFields: Record<string, string>

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

---

rdfsClass?

static optional rdfsClass: string

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

---

rdfsClasses

static rdfsClasses: string[] = []

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

---

rdfsClassesAliases

static rdfsClassesAliases: string[][] = []

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

---

relations

static relations: string[] = []

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

Inherited from

SolidModelBase.relations

---

reservedRelations

static reservedRelations: string[]

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

---

slugField?

static optional slugField: string

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

---

softDeletesEnabled

protected static softDeletesEnabled: boolean = false

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

---

timestamps

static timestamps: TimestampsDefinition

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

Inherited from

SolidModelBase.timestamps

---

tombstone

static tombstone: boolean = true

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

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

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

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

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

Parameters

ignoreRelations?

boolean

Returns

Promise<void>

Overrides

SolidModelBase.afterSave

---

attributeValueChanged()

protected attributeValueChanged(originalValue, newValue): boolean

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

Parameters

originalValue

unknown

newValue

unknown

Returns

boolean

Inherited from

SolidModelBase.attributeValueChanged

---

authorizationsRelationship()

authorizationsRelationship(): Relation

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

Returns

Relation

---

beforeCreate()

protected beforeCreate(): Promise<void>

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

Returns

Promise<void>

---

beforeDocumentSave()

protected beforeDocumentSave(): Promise<void>

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

Returns

Promise<void>

---

beforeSave()

protected beforeSave(ignoreRelations?): Promise<void>

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

Parameters

ignoreRelations?

boolean

Returns

Promise<void>

Overrides

SolidModelBase.beforeSave

---

beforeUpdate()

protected beforeUpdate(): Promise<void>

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

Returns

Promise<void>

---

belongsToMany()

Call Signature

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

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

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

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

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

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

Parameters

field

string

Returns

unknown

Inherited from

SolidModelBase.callAttributeGetter

---

callAttributeSetter()

callAttributeSetter(field, value): void

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

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

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

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

Parameters

ignoreRelations?

boolean

Returns

void

Overrides

SolidModelBase.cleanDirty

---

clone()

Call Signature

clone(options?): this

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

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

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

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

Parameters

documents

Record<string, EngineDocument>

Returns

Promise<SolidModel[]>

Overrides

SolidModelBase.createManyFromEngineDocuments

---

delete()

delete(): Promise<SolidModel>

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

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

Parameters

models

SolidModel[]

Returns

Promise<void>

Overrides

SolidModelBase.deleteModelsFromEngine

---

disableHistory()

disableHistory(): void

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

Returns

void

Inherited from

SolidModelBase.disableHistory

---

disableTombstone()

disableTombstone(): void

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

Returns

void

Inherited from

SolidModelBase.disableTombstone

---

documentContainsMany()

protected documentContainsMany<T>(model): DocumentContainsManyRelation

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

Type Parameters

T

T extends typeof SolidModel

Parameters

model

T

Returns

DocumentContainsManyRelation

---

documentExists()

documentExists(): boolean

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

Returns

boolean

---

emit()

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

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

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

Returns

void

Inherited from

SolidModelBase.enableHistory

---

enableTombstone()

enableTombstone(): void

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

Returns

void

Inherited from

SolidModelBase.enableTombstone

---

exists()

exists(): boolean

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

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

Returns

void

Overrides

SolidModelBase.fixMalformedAttributes

---

forceDelete()

forceDelete(): Promise<SolidModel>

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

Returns

Promise<SolidModel>

---

fresh()

fresh(): Promise<SolidModel>

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

Returns

Promise<SolidModel>

Inherited from

SolidModelBase.fresh

---

getAttribute()

getAttribute<T>(field, includeUndefined): T

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

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

Parameters

includeUndefined

boolean = false

Returns

Attributes

Inherited from

SolidModelBase.getAttributes

---

getAttributeValue()

getAttributeValue<T>(field, includeUndefined): T

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

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

Returns

Promise<Model[]>

Inherited from

SolidModelBase.getCascadeModels

---

getContainerUrl()

getContainerUrl(): null | string

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

Returns

null | string

---

getCreatedAtAttribute()

getCreatedAtAttribute(): Date

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

Returns

Date

---

getDefaultCollection()

getDefaultCollection(): string

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

Returns

string

Overrides

SolidModelBase.getDefaultCollection

---

getDeletedAtAttribute()

getDeletedAtAttribute(): undefined | Date

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

Returns

undefined | Date

---

getDeletedPrimaryKey()

getDeletedPrimaryKey(): null | Key

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

Returns

null | Key

Inherited from

SolidModelBase.getDeletedPrimaryKey

---

getDirtyDocumentModels()

getDirtyDocumentModels(): SolidModel[]

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

Returns

SolidModel[]

---

getDirtyEngineDocumentUpdates()

protected getDirtyEngineDocumentUpdates(ignoreRelations?): EngineUpdates

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

Parameters

ignoreRelations?

boolean

Returns

EngineUpdates

Overrides

SolidModelBase.getDirtyEngineDocumentUpdates

---

getDocumentModels()

getDocumentModels(): SolidModel[]

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

Returns

SolidModel[]

---

getDocumentUrl()

getDocumentUrl(): null | string

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

Returns

null | string

---

getEngine()

getEngine(): undefined | Engine

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

Returns

undefined | Engine

Inherited from

SolidModelBase.getEngine

---

getFinalEngine()

getFinalEngine(): undefined | Engine

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

Returns

undefined | Engine

Inherited from

SolidModelBase.getFinalEngine

---

getHistoryHash()

getHistoryHash(this): null | string

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

Parameters

this

TracksHistoryThis

Returns

null | string

Inherited from

SolidModelBase.getHistoryHash

---

getIdAttribute()

getIdAttribute(): string

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

Returns

string

---

getMalformedDocumentAttributes()

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

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

Returns

Record<string, string[]>

Inherited from

SolidModelBase.getMalformedDocumentAttributes

---

getMetadataSchemaUpdates()

protected getMetadataSchemaUpdates(this, dirtyUrl): EngineAttributeUpdateOperation[]

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

Parameters

this

SolidModel

dirtyUrl

Nullable<string>

Returns

EngineAttributeUpdateOperation[]

Inherited from

SolidModelBase.getMetadataSchemaUpdates

---

getOperationSchemaUpdates()

protected getOperationSchemaUpdates(this, model, removedFields, dirtyUrl, options): Promise<EngineAttributeUpdateOperation[]>

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

Parameters

this

SolidModel

model

SolidModel

removedFields

string[]

dirtyUrl

Nullable<string>

options

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

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

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

Returns

null | Key

Inherited from

SolidModelBase.getPrimaryKey

---

getRelatedModels()

getRelatedModels(): SolidModel[]

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

Returns

SolidModel[]

---

getRelation()

getRelation<T>(relation): null | T

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

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

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

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

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

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

Returns

SolidModel[]

---

getResourceSchemaUpdate()

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

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

Parameters

this

SolidModel

model

SolidModel

dirtyUrl?

Nullable<string>

Returns

EngineAttributeUpdateOperation

Inherited from

SolidModelBase.getResourceSchemaUpdate

---

getSchemaUpdates()

protected getSchemaUpdates<T>(this, schema, options): Promise<{ model: T; updates: EngineAttributeUpdateOperation[]; }>

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModel

schema

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

Returns

null | string

Inherited from

SolidModelBase.getSerializedPrimaryKey

---

getSourceContainerUrl()

getSourceContainerUrl(): null | string

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

Returns

null | string

---

getSourceDocumentUrl()

getSourceDocumentUrl(): null | string

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

Returns

null | string

---

getUpdatedAtAttribute()

getUpdatedAtAttribute(): Date

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

Returns

Date

---

getUrlSchemaUpdates()

protected getUrlSchemaUpdates(this, dirtyUrl): EngineAttributeUpdateOperation[]

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

Parameters

this

SolidModel

dirtyUrl

Nullable<string>

Returns

EngineAttributeUpdateOperation[]

Inherited from

SolidModelBase.getUrlSchemaUpdates

---

guessCollection()

protected guessCollection(): undefined | string

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

Returns

undefined | string

---

hasAttribute()

hasAttribute(field): boolean

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

Parameters

field

string

Returns

boolean

Inherited from

SolidModelBase.hasAttribute

---

hasAttributeGetter()

hasAttributeGetter(field): boolean

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

Parameters

field

string

Returns

boolean

Inherited from

SolidModelBase.hasAttributeGetter

---

hasAttributeSetter()

hasAttributeSetter(field): boolean

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

Parameters

field

string

Returns

boolean

Inherited from

SolidModelBase.hasAttributeSetter

---

hasIncompleteAttributes()

hasIncompleteAttributes(): boolean

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

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

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

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

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

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

Parameters

relation

string

Returns

boolean

Inherited from

SolidModelBase.hasRelation

---

ignoreRdfPropertyHistory()

ignoreRdfPropertyHistory(rdfProperty, withSolidEngine?): boolean

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

Parameters

rdfProperty

string

withSolidEngine?

boolean

Returns

boolean

---

initialize()

protected initialize(attributes, exists): void

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

Parameters

attributes

Attributes

exists

boolean

Returns

void

Overrides

SolidModelBase.initialize

---

initializeAttributes()

protected initializeAttributes(attributes, exists): void

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

Parameters

attributes

Attributes

exists

boolean

Returns

void

Inherited from

SolidModelBase.initializeAttributes

---

initializeMetadataRelation()

protected initializeMetadataRelation(): void

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

Returns

void

---

initializeProxy()

protected initializeProxy(): void

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

Returns

void

Inherited from

SolidModelBase.initializeProxy

---

initializeRelations()

protected initializeRelations(): void

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

Returns

void

Overrides

SolidModelBase.initializeRelations

---

initializeRelationsEnabling()

protected initializeRelationsEnabling(): void

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

Returns

void

---

is()

is(another): boolean

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

Parameters

another

this

Returns

boolean

Inherited from

SolidModelBase.is

---

isContainedBy()

protected isContainedBy<T>(model): SolidIsContainedByRelation

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

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

Parameters

field?

string

ignoreRelations?

boolean

Returns

boolean

Overrides

SolidModelBase.isDirty

---

isRelationLoaded()

isRelationLoaded(relation): boolean

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

Parameters

relation

string

Returns

boolean

Inherited from

SolidModelBase.isRelationLoaded

---

isSoftDeleted()

isSoftDeleted(): boolean

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

Returns

boolean

---

leavesTombstone()

leavesTombstone(this): boolean

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

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

Parameters

documentUrl

string

document

EngineDocument

Returns

Promise<void>

---

loadEmptyRelations()

protected loadEmptyRelations(): Promise<void>

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

Returns

Promise<void>

Inherited from

SolidModelBase.loadEmptyRelations

---

loadRelation()

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

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

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

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

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

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

Parameters

models

SolidModel[]

Returns

void

---

mintUrl()

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

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

Parameters

documentUrl?

string

documentExists?

boolean

resourceHash?

string

Returns

void

---

newInstance()

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

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

Type Parameters

T

T extends Model

Parameters

this

T

params

...[Attributes, boolean]

Returns

T

Inherited from

SolidModelBase.newInstance

---

newInstanceForSchema()

protected newInstanceForSchema<T>(this, schema, addedFields, removedFields): Promise<T>

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModel

schema

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

Parameters

url?

string

Returns

string

---

newUrl()

protected newUrl(documentUrl?, resourceHash?): string

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

Parameters

documentUrl?

string

resourceHash?

null | string

Returns

string

---

newUrlDocumentUrl()

protected newUrlDocumentUrl(): string

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

Returns

string

---

newUrlDocumentUrlSlug()

protected newUrlDocumentUrlSlug(): null | string

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

Returns

null | string

---

newUrlResourceHash()

protected newUrlResourceHash(): null | string

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

Returns

null | string

---

onMoved()

onMoved(newResourceUrl, newDocumentUrl?): void

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

Parameters

newResourceUrl

string

newDocumentUrl?

string

Returns

void

---

onPrimaryKeyUpdated()

protected onPrimaryKeyUpdated(value, oldValue): void

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

Parameters

value

null | Key

oldValue

null | Key

Returns

void

---

operationsRelationship()

operationsRelationship(): Relation

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

Returns

Relation

---

parseEngineDocumentAttributes()

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

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

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

Parameters

key

string

Returns

Key

Inherited from

SolidModelBase.parseKey

---

performDelete()

protected performDelete(): Promise<void>

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

Returns

Promise<void>

Overrides

SolidModelBase.performDelete

---

performMalformedAttributeFixes()

protected performMalformedAttributeFixes(): void

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

Returns

void

Inherited from

SolidModelBase.performMalformedAttributeFixes

---

performSave()

protected performSave(): Promise<void>

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

Returns

Promise<void>

Overrides

SolidModelBase.performSave

---

populateCascadeModels()

protected populateCascadeModels(cascadeModels): Promise<void>

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

Parameters

cascadeModels

Set<Model>

Returns

Promise<void>

Inherited from

SolidModelBase.populateCascadeModels

---

rebuildAttributesFromHistory()

rebuildAttributesFromHistory(this): void

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

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

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

Parameters

typeIndexUrl

string

Returns

Promise<void>

---

removeDuplicatedHistoryOperations()

protected removeDuplicatedHistoryOperations(this): void

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

Parameters

this

TracksHistoryThis

Returns

void

Inherited from

SolidModelBase.removeDuplicatedHistoryOperations

---

requireContainerUrl()

requireContainerUrl(): string

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

Returns

string

---

requireDocumentUrl()

requireDocumentUrl(): string

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

Returns

string

---

requireEngine()

requireEngine<T>(): T

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

Type Parameters

T

T extends Engine

Returns

T

Inherited from

SolidModelBase.requireEngine

---

requireFinalEngine()

requireFinalEngine<T>(): T

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

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

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

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

Returns

void

Inherited from

SolidModelBase.reset

---

resetEngineData()

protected resetEngineData(): void

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

Returns

void

Deprecated

use reset instead.

Inherited from

SolidModelBase.resetEngineData

---

save()

save(collection?): Promise<SolidModel>

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

Parameters

collection?

string

Returns

Promise<SolidModel>

Overrides

SolidModelBase.save

---

saveInDocument()

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

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

Parameters

documentUrl

string

resourceHash?

string

Returns

Promise<SolidModel>

---

serializeKey()

protected serializeKey(key): string

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

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

Parameters

field

string

value

unknown

Returns

void

Overrides

SolidModelBase.setAttribute

---

setAttributes()

setAttributes(attributes): void

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

Parameters

attributes

Attributes

Returns

void

Inherited from

SolidModelBase.setAttributes

---

setAttributeValue()

setAttributeValue(field, value): void

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

Parameters

field

string

value

unknown

Returns

void

Inherited from

SolidModelBase.setAttributeValue

---

setCreatedAtAttribute()

setCreatedAtAttribute(value): void

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

Parameters

value

unknown

Returns

void

---

setDocumentExists()

setDocumentExists(documentExists): void

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

Parameters

documentExists

boolean

Returns

void

---

setEngine()

setEngine(engine?): void

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

Parameters

engine?

Engine

Returns

void

Inherited from

SolidModelBase.setEngine

---

setExists()

setExists(exists): void

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

Parameters

exists

boolean

Returns

void

Overrides

SolidModelBase.setExists

---

setMalformedDocumentAttributes()

setMalformedDocumentAttributes(malformedAttributes): void

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

Parameters

malformedAttributes

Record<string, string[]>

Returns

void

Inherited from

SolidModelBase.setMalformedDocumentAttributes

---

setOriginalAttribute()

setOriginalAttribute(field, value): void

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

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

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

Parameters

relation

string

models

null | SolidModel[]

Returns

void

Overrides

SolidModelBase.setRelationModels

---

setSourceDocumentUrl()

setSourceDocumentUrl(sourceDocumentUrl): void

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

Parameters

sourceDocumentUrl

null | string

Returns

void

---

setUpdatedAtAttribute()

setUpdatedAtAttribute(value): void

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

Parameters

value

unknown

Returns

void

---

softDelete()

softDelete(): Promise<SolidModel>

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

Returns

Promise<SolidModel>

---

static()

Call Signature

static(property): SolidBootedFieldsDefinition

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

Parameters

property

"fields"

Returns

SolidBootedFieldsDefinition

Overrides

SolidModelBase.static

Call Signature

static(property): TimestampFieldValue[]

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

Parameters

property

"timestamps"

Returns

TimestampFieldValue[]

Overrides

SolidModelBase.static

Call Signature

static<T>(): T

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

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

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

Returns

Promise<string>

Overrides

SolidModelBase.syncDirty

---

toEngineDocument()

protected toEngineDocument(): EngineDocument

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

Returns

EngineDocument

Overrides

SolidModelBase.toEngineDocument

---

toJsonLD()

toJsonLD(options): Record<string, unknown>

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

Parameters

options

SolidModelSerializationOptions = {}

Returns

Record<string, unknown>

---

tombstoneRelationship()

tombstoneRelationship(): Relation

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

Returns

Relation

---

toTurtle()

toTurtle(options): Promise<string>

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

Parameters

options

SolidModelSerializationOptions = {}

Returns

Promise<string>

---

touch()

touch(): void

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

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

Parameters

this

TracksHistoryThis

Returns

boolean

Inherited from

SolidModelBase.tracksHistory

---

unloadRelation()

unloadRelation(relation): void

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

Parameters

relation

string

Returns

void

Inherited from

SolidModelBase.unloadRelation

---

unsetAttribute()

unsetAttribute(field): void

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

Parameters

field

string

Returns

void

Overrides

SolidModelBase.unsetAttribute

---

update()

update(attributes?): Promise<SolidModel>

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

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

Parameters

this

SolidModel

graphUpdates

EngineAttributeUpdateOperation[]

Returns

Promise<void>

Inherited from

SolidModelBase.updateEngineDocumentSchema

---

updatePublicPermissions()

updatePublicPermissions(this, permissions): Promise<void>

Defined in: packages/soukai-solid/src/models/mixins/ManagesPermissions.ts:44

Parameters

this

SolidModel

permissions

SolidDocumentPermission[]

Returns

Promise<void>

Inherited from

SolidModelBase.updatePublicPermissions

---

usesRdfAliases()

usesRdfAliases(): boolean

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

Returns

boolean

---

usingSolidEngine()

usingSolidEngine(): boolean

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

Returns

boolean

---

wasRecentlyCreated()

wasRecentlyCreated(): boolean

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

Returns

boolean

Inherited from

SolidModelBase.wasRecentlyCreated

---

wasRecentlyDeleted()

wasRecentlyDeleted(): boolean

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

Returns

boolean

Inherited from

SolidModelBase.wasRecentlyDeleted

---

withEngine()

Call Signature

withEngine(engine): this

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

Parameters

engine

Engine

Returns

this

Inherited from

SolidModelBase.withEngine

Call Signature

withEngine<T>(engine, operation): T

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

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

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

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

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

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

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

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

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

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

Parameters

name?

string

Returns

void

Overrides

SolidModelBase.boot

---

bootClassDefinitions()

protected static bootClassDefinitions(): object

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

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

Returns

string

Overrides

SolidModelBase.bootCollection

---

bootFields()

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

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

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?): ModelHooks

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

Parameters

hooks?

ModelHooks

Returns

ModelHooks

Inherited from

SolidModelBase.bootHooks

---

bootModelName()

protected static bootModelName(name?): string

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

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

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

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

Parameters

rdfsClassesAliases

string[][]

rdfContexts

RDFContexts

Returns

string[][]

---

bootTimestamps()

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

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

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

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

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

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

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

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

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

Returns

void

Inherited from

SolidModelBase.ensureBooted

---

exclusive()

static exclusive<T>(operation): Promise<T>

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

Type Parameters

T

T

Parameters

operation

() => T | Promise<T>

Returns

Promise<T>

Inherited from

SolidModelBase.exclusive

---

find()

Call Signature

static find<T>(this, id): Promise<null | T>

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

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

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

Parameters

quads

Quad[]

baseUrl?

string

Returns

string[]

---

findOrFail()

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

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

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

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

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

Parameters

rdfContexts?

RDFContexts

Returns

string

---

getEngine()

static getEngine(): undefined | Engine

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

Returns

undefined | Engine

Inherited from

SolidModelBase.getEngine

---

getFieldDefinition()

static getFieldDefinition(field, value?): SolidBootedFieldDefinition

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

Parameters

field

string

value?

unknown

Returns

SolidBootedFieldDefinition

---

getFieldRdfProperty()

static getFieldRdfProperty(field): null | string

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

Parameters

field

string

Returns

null | string

---

getFinalEngine()

static getFinalEngine(): undefined | Engine

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

Returns

undefined | Engine

Inherited from

SolidModelBase.getFinalEngine

---

getRdfPropertyField()

static getRdfPropertyField(rdfProperty): null | string

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

Parameters

rdfProperty

string

Returns

null | string

---

hasAutomaticTimestamp()

static hasAutomaticTimestamp(timestamp): boolean

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

Parameters

timestamp

TimestampFieldValue

Returns

boolean

Inherited from

SolidModelBase.hasAutomaticTimestamp

---

hasAutomaticTimestamps()

static hasAutomaticTimestamps(): boolean

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

Returns

boolean

Inherited from

SolidModelBase.hasAutomaticTimestamps

---

instance()

static instance<T>(this): T

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

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

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

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

Type Parameters

TModel

TModel extends Model

TEvent

TEvent extends keyof ModelEvents | "schema-updated"

Parameters

this

ModelConstructor<TModel>

event

TEvent

listener

ModelListener<TModel, TEvent>

Returns

(): void

Returns

void

Inherited from

SolidModelBase.on

---

performSchemaUpdate()

protected static performSchemaUpdate(schema): Promise<void>

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

Parameters

schema

SolidSchemaDefinition | SolidModelConstructor

Returns

Promise<void>

Overrides

SolidModelBase.performSchemaUpdate

---

prepareEngineFilters()

static prepareEngineFilters(filters): EngineFilters

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

Parameters

filters

EngineFilters = {}

Returns

EngineFilters

---

pureInstance()

protected static pureInstance<T>(this): T

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

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

Parameters

property

string

rdfContexts?

RDFContexts

Returns

string

---

replaceRdfPrefixes()

static replaceRdfPrefixes(replacements): void

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

Parameters

replacements

Record<string, string>

Returns

void

---

requireEngine()

static requireEngine<T>(): T

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

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

Returns

Fetch

---

requireFieldRdfProperty()

static requireFieldRdfProperty(field): string

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

Parameters

field

string

Returns

string

---

requireFinalEngine()

static requireFinalEngine<T>(): T

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

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

Returns

void

---

setEngine()

static setEngine(engine?): void

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

Parameters

engine?

Engine

Returns

void

Inherited from

SolidModelBase.setEngine

---

synchronize()

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

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

a

T

b

T

options

object & SynchronizeCloneOptions = {}

Returns

Promise<void>

---

updateSchema()

Call Signature

static updateSchema(schema): Promise<void>

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

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

Parameters

schema

ModelConstructor | Partial<{ fields: FieldsDefinition<unknown>; hooks?: ModelHooks; primaryKey: string; timestamps: TimestampsDefinition; }>

Returns

Promise<void>

Overrides

SolidModelBase.updateSchema

---

useSoftDeletes()

static useSoftDeletes(enabled): void

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

Parameters

enabled

boolean

Returns

void

---

usingSolidEngine()

static usingSolidEngine(): boolean

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

Returns

boolean

---

withCollection()

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

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

Type Parameters

Result

Result

Parameters

collection

undefined | string

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

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

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

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

Type Parameters

T

T

Parameters

operation

() => Promise<T>

Returns

Promise<T>

Inherited from

SolidModelBase.withoutTimestamps