Class: Tombstone

Defined in: packages/soukai-solid/src/models/history/Tombstone.ts:3

Extends

• Metadata

Constructors

Constructor

new Tombstone(attributes?, _?): Tombstone

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

Parameters

attributes?

Attributes = {}

_?

boolean

Returns

Tombstone

Inherited from

Metadata.constructor

Properties

_attributes

protected _attributes: Attributes

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

Inherited from

Metadata._attributes

---

_dirtyAttributes

protected _dirtyAttributes: Attributes

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

Inherited from

Metadata._dirtyAttributes

---

_documentExists

protected _documentExists: boolean

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

Inherited from

Metadata._documentExists

---

_exists

protected _exists: boolean

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

Inherited from

Metadata._exists

---

_malformedDocumentAttributes

protected _malformedDocumentAttributes: Record<string, string[]>

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

Inherited from

Metadata._malformedDocumentAttributes

---

_originalAttributes

protected _originalAttributes: Attributes

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

Inherited from

Metadata._originalAttributes

---

_proxy

protected _proxy: Tombstone

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

Inherited from

Metadata._proxy

---

_publicPermissions

protected _publicPermissions: SolidDocumentPermission[] | undefined

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

Inherited from

Metadata._publicPermissions

---

_relations

protected _relations: Record<string, SolidRelation>

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

Inherited from

Metadata._relations

---

_removedResourceUrls

protected _removedResourceUrls: string[]

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

Inherited from

Metadata._removedResourceUrls

---

_sourceDocumentUrl

protected _sourceDocumentUrl: string | null

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

Inherited from

Metadata._sourceDocumentUrl

---

_trackedDirtyAttributes

protected _trackedDirtyAttributes: Attributes

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

Inherited from

Metadata._trackedDirtyAttributes

---

_usesRdfAliases

protected _usesRdfAliases: boolean

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

Inherited from

Metadata._usesRdfAliases

---

_wasRecentlyCreated

protected _wasRecentlyCreated: boolean

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

Inherited from

Metadata._wasRecentlyCreated

---

authorizations?

optional authorizations?: SolidACLAuthorization[]

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

Inherited from

Metadata.authorizations

---

createdAt?

optional createdAt?: Date = FieldType.Date

Defined in: packages/soukai-solid/src/models/history/Metadata.schema.ts:14

Inherited from

Metadata.createdAt

---

deletedAt?

optional deletedAt?: Date = FieldType.Date

Defined in: packages/soukai-solid/src/models/history/Metadata.schema.ts:16

Inherited from

Metadata.deletedAt

---

id

id: string

Defined in: packages/soukai/src/models/inference.ts:30

Inherited from

Metadata.id

---

metadata

metadata: Metadata

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

Inherited from

Metadata.metadata

---

operations

operations: Operation[]

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

Inherited from

Metadata.operations

---

relatedAuthorizations

relatedAuthorizations: SolidACLAuthorizationsRelation<Tombstone>

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

Inherited from

Metadata.relatedAuthorizations

---

relatedMetadata

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

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

Inherited from

Metadata.relatedMetadata

---

relatedOperations

relatedOperations: OperationsRelation<Tombstone>

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

Inherited from

Metadata.relatedOperations

---

relatedTombstone

relatedTombstone: TombstoneRelation<Tombstone>

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

Inherited from

Metadata.relatedTombstone

---

resourceUrl

resourceUrl: string

Defined in: packages/soukai-solid/src/models/history/Metadata.schema.ts:9

Inherited from

Metadata.resourceUrl

---

tombstone?

optional tombstone?: Tombstone

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

Inherited from

Metadata.tombstone

---

updatedAt?

optional updatedAt?: Date = FieldType.Date

Defined in: packages/soukai-solid/src/models/history/Metadata.schema.ts:15

Inherited from

Metadata.updatedAt

---

url

url: string

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

Inherited from

Metadata.url

---

__attributeGetters

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

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

Inherited from

Metadata.__attributeGetters

---

__attributeSetters

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

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

Inherited from

Metadata.__attributeSetters

---

__isSchema?

static optional __isSchema?: boolean

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

Inherited from

Metadata.__isSchema

---

classFields

static classFields: string[]

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

Inherited from

Metadata.classFields

---

collection

static collection: string

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

Inherited from

Metadata.collection

---

defaultResourceHash

static defaultResourceHash: string | null = 'it'

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

Inherited from

Metadata.defaultResourceHash

---

fields

static fields: SolidFieldsDefinition

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

Inherited from

Metadata.fields

---

history

static history: boolean = false

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

Inherited from

Metadata.history

---

historyDisabled

protected static historyDisabled: WeakMap<SolidModel, void>

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

Inherited from

Metadata.historyDisabled

---

hooks

static hooks: ModelHooks = {}

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

Inherited from

Metadata.hooks

---

mintsUrls

static mintsUrls: boolean = true

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

Inherited from

Metadata.mintsUrls

---

modelName

static modelName: string

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

Inherited from

Metadata.modelName

---

primaryKey

static primaryKey: string = 'url'

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

Inherited from

Metadata.primaryKey

---

rdfContext?

static optional rdfContext?: string

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

Inherited from

Metadata.rdfContext

---

rdfContexts

static rdfContexts: RDFContexts = {}

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

Inherited from

Metadata.rdfContexts

---

rdfPropertyFields?

protected static optional rdfPropertyFields?: Record<string, string>

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

Inherited from

Metadata.rdfPropertyFields

---

rdfsClass

static rdfsClass: string = 'Tombstone'

Defined in: packages/soukai-solid/src/models/history/Tombstone.ts:4

Overrides

Metadata.rdfsClass

---

rdfsClasses

static rdfsClasses: string[] = []

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

Inherited from

Metadata.rdfsClasses

---

rdfsClassesAliases

static rdfsClassesAliases: string[][] = []

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

Inherited from

Metadata.rdfsClassesAliases

---

relations

static relations: string[] = []

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

Inherited from

Metadata.relations

---

reservedRelations

static reservedRelations: string[]

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

Inherited from

Metadata.reservedRelations

---

slugField?

static optional slugField?: string

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

Inherited from

Metadata.slugField

---

softDeletesEnabled

protected static softDeletesEnabled: boolean = false

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

Inherited from

Metadata.softDeletesEnabled

---

timestamps

static timestamps: TimestampsDefinition

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

Inherited from

Metadata.timestamps

---

tombstone

static tombstone: boolean = true

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

Inherited from

Metadata.tombstone

Accessors

isPrivate

Get Signature

get isPrivate(): boolean | null

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

Returns

boolean | null

Inherited from

Metadata.isPrivate

---

isPublic

Get Signature

get isPublic(): boolean | null

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

Returns

boolean | null

Inherited from

Metadata.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

Metadata.addArrayHistoryOperations

---

addDirtyHistoryOperations()

protected addDirtyHistoryOperations(this): Promise<void>

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

Parameters

this

TracksHistoryThis

Returns

Promise<void>

Inherited from

Metadata.addDirtyHistoryOperations

---

addHistoryOperations()

addHistoryOperations(this, operations): void

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

Parameters

this

TracksHistoryThis

operations

Operation[]

Returns

void

Inherited from

Metadata.addHistoryOperations

---

afterSave()

protected afterSave(ignoreRelations?): Promise<void>

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

Parameters

ignoreRelations?

boolean

Returns

Promise<void>

Inherited from

Metadata.afterSave

---

attributeValueChanged()

protected attributeValueChanged(originalValue, newValue): boolean

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

Parameters

originalValue

unknown

newValue

unknown

Returns

boolean

Inherited from

Metadata.attributeValueChanged

---

authorizationsRelationship()

authorizationsRelationship(): Relation

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

Returns

Relation

Inherited from

Metadata.authorizationsRelationship

---

beforeCreate()

protected beforeCreate(): Promise<void>

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

Returns

Promise<void>

Inherited from

Metadata.beforeCreate

---

beforeDocumentSave()

protected beforeDocumentSave(): Promise<void>

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

Returns

Promise<void>

Inherited from

Metadata.beforeDocumentSave

---

beforeSave()

protected beforeSave(ignoreRelations?): Promise<void>

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

Parameters

ignoreRelations?

boolean

Returns

Promise<void>

Inherited from

Metadata.beforeSave

---

beforeUpdate()

protected beforeUpdate(): Promise<void>

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

Returns

Promise<void>

Inherited from

Metadata.beforeUpdate

---

belongsToMany()

Call Signature

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

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

Creates a relation when this model references multiple instances of another model.

Type Parameters

T

T extends typeof SolidModel

Parameters

relatedClass

T

Related model class.

foreignKeyField?

string

Name of the foreign key field in the local model.

localKeyField?

string

Name of the local key field in the related model. Defaults to the primary key name defined in the related model class.

Returns

SolidBelongsToManyRelation

Inherited from

Metadata.belongsToMany

Call Signature

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

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

Type Parameters

T

T extends typeof Model

Parameters

relatedClass

T

foreignKeyField?

string

localKeyField?

string

Returns

Relation

Inherited from

Metadata.belongsToMany

---

belongsToOne()

Call Signature

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

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

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

Inherited from

Metadata.belongsToOne

Call Signature

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

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

Type Parameters

T

T extends typeof Model

Parameters

relatedClass

T

foreignKeyField?

string

localKeyField?

string

Returns

Relation

Inherited from

Metadata.belongsToOne

---

callAttributeGetter()

callAttributeGetter(field): unknown

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

Parameters

field

string

Returns

unknown

Inherited from

Metadata.callAttributeGetter

---

callAttributeSetter()

callAttributeSetter(field, value): void

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

Parameters

field

string

value

unknown

Returns

void

Inherited from

Metadata.callAttributeSetter

---

castAttribute()

protected castAttribute(value, options?): unknown

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

Parameters

value

unknown

options?

ModelCastAttributeOptions = {}

Returns

unknown

Inherited from

Metadata.castAttribute

---

castAttributes()

protected castAttributes(attributes, definitions, malformedAttributes?, fieldPrefix?): Attributes

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

Parameters

attributes

Attributes

definitions

BootedFieldsDefinition

malformedAttributes?

Record<string, string[]>

fieldPrefix?

string = ''

Returns

Attributes

Inherited from

Metadata.castAttributes

---

cleanDirty()

cleanDirty(ignoreRelations?): void

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

Parameters

ignoreRelations?

boolean

Returns

void

Inherited from

Metadata.cleanDirty

---

clone()

Call Signature

clone(options?): this

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

Parameters

options?

Partial<{ clean: boolean; clones: WeakMap<Model, Model>; constructors: WeakMap<typeof Model, typeof Model> | [typeof Model, typeof Model][]; }>

Returns

this

Inherited from

Metadata.clone

Call Signature

clone<T>(options?): T

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

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

Metadata.clone

---

convertEngineFiltersToJsonLD()

protected convertEngineFiltersToJsonLD(this, filters, compactIRIs): EngineFilters

Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:69

Parameters

this

SolidModel

filters

EngineFilters

compactIRIs

boolean

Returns

EngineFilters

Inherited from

Metadata.convertEngineFiltersToJsonLD

---

convertEngineUpdatesToJsonLD()

protected convertEngineUpdatesToJsonLD(this, updates, compactIRIs): EngineUpdates

Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:110

Parameters

this

SolidModel

updates

EngineUpdates

compactIRIs

boolean

Returns

EngineUpdates

Inherited from

Metadata.convertEngineUpdatesToJsonLD

---

createFromEngineDocument()

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

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

Parameters

id

Key

document

EngineDocument

resourceId?

string

Returns

Promise<Tombstone>

Inherited from

Metadata.createFromEngineDocument

---

createManyFromEngineDocuments()

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

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

Parameters

documents

Record<string, EngineDocument>

Returns

Promise<Tombstone[]>

Inherited from

Metadata.createManyFromEngineDocuments

---

delete()

delete(): Promise<Tombstone>

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

Returns

Promise<Tombstone>

Inherited from

Metadata.delete

---

deleteModels()

protected deleteModels(this, models): Promise<void>

Defined in: packages/soukai-solid/src/models/mixins/DeletesModels.ts:14

Parameters

this

SolidModel

models

SolidModel[]

Returns

Promise<void>

Inherited from

Metadata.deleteModels

---

deleteModelsFromEngine()

protected deleteModelsFromEngine(models): Promise<void>

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

Parameters

models

Tombstone[]

Returns

Promise<void>

Inherited from

Metadata.deleteModelsFromEngine

---

disableHistory()

disableHistory(): void

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

Returns

void

Inherited from

Metadata.disableHistory

---

disableTombstone()

disableTombstone(): void

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

Returns

void

Inherited from

Metadata.disableTombstone

---

documentContainsMany()

protected documentContainsMany<T>(model): DocumentContainsManyRelation

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

Type Parameters

T

T extends typeof SolidModel

Parameters

model

T

Returns

DocumentContainsManyRelation

Inherited from

Metadata.documentContainsMany

---

documentExists()

documentExists(): boolean

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

Returns

boolean

Inherited from

Metadata.documentExists

---

emit()

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

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

Type Parameters

T

T extends keyof ModelEvents

Parameters

args

...ModelEmitArgs<T>

Returns

Promise<void>

Inherited from

Metadata.emit

---

enableHistory()

enableHistory(): void

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

Returns

void

Inherited from

Metadata.enableHistory

---

enableTombstone()

enableTombstone(): void

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

Returns

void

Inherited from

Metadata.enableTombstone

---

exists()

exists(): boolean

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

Returns

boolean

Inherited from

Metadata.exists

---

fetchPublicPermissions()

fetchPublicPermissions(this): Promise<void>

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

Parameters

this

SolidModel

Returns

Promise<void>

Inherited from

Metadata.fetchPublicPermissions

---

fetchPublicPermissionsIfMissing()

fetchPublicPermissionsIfMissing(this): Promise<void>

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

Parameters

this

SolidModel

Returns

Promise<void>

Inherited from

Metadata.fetchPublicPermissionsIfMissing

---

fixMalformedAttributes()

fixMalformedAttributes(): void

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

Returns

void

Inherited from

Metadata.fixMalformedAttributes

---

forceDelete()

forceDelete(): Promise<Tombstone>

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

Returns

Promise<Tombstone>

Inherited from

Metadata.forceDelete

---

fresh()

fresh(): Promise<Tombstone>

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

Returns

Promise<Tombstone>

Inherited from

Metadata.fresh

---

getAttribute()

getAttribute<T>(field, includeUndefined?): T

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

Type Parameters

T

T = unknown

Parameters

field

string

includeUndefined?

boolean = false

Returns

T

Inherited from

Metadata.getAttribute

---

getAttributes()

getAttributes(includeUndefined?): Attributes

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

Parameters

includeUndefined?

boolean = false

Returns

Attributes

Inherited from

Metadata.getAttributes

---

getAttributeValue()

getAttributeValue<T>(field, includeUndefined?): T

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

Type Parameters

T

T = unknown

Parameters

field

string

includeUndefined?

boolean = false

Returns

T

Inherited from

Metadata.getAttributeValue

---

getCascadeModels()

protected getCascadeModels(): Promise<Model[]>

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

Returns

Promise<Model[]>

Inherited from

Metadata.getCascadeModels

---

getContainerUrl()

getContainerUrl(): string | null

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

Returns

string | null

Inherited from

Metadata.getContainerUrl

---

getCreatedAtAttribute()

getCreatedAtAttribute(): Date

Defined in: packages/soukai-solid/src/models/history/Metadata.ts:4

Returns

Date

Inherited from

Metadata.getCreatedAtAttribute

---

getDefaultCollection()

getDefaultCollection(): string

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

Returns

string

Inherited from

Metadata.getDefaultCollection

---

getDeletedAtAttribute()

getDeletedAtAttribute(): Date | undefined

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

Returns

Date | undefined

Inherited from

Metadata.getDeletedAtAttribute

---

getDeletedPrimaryKey()

getDeletedPrimaryKey(): Key | null

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

Returns

Key | null

Inherited from

Metadata.getDeletedPrimaryKey

---

getDirtyDocumentModels()

getDirtyDocumentModels(): SolidModel[]

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

Returns

SolidModel[]

Inherited from

Metadata.getDirtyDocumentModels

---

getDirtyEngineDocumentUpdates()

protected getDirtyEngineDocumentUpdates(ignoreRelations?): EngineUpdates

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

Parameters

ignoreRelations?

boolean

Returns

EngineUpdates

Inherited from

Metadata.getDirtyEngineDocumentUpdates

---

getDocumentModels()

getDocumentModels(): SolidModel[]

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

Returns

SolidModel[]

Inherited from

Metadata.getDocumentModels

---

getDocumentUrl()

getDocumentUrl(): string | null

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

Returns

string | null

Inherited from

Metadata.getDocumentUrl

---

getEngine()

getEngine(): Engine | undefined

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

Returns

Engine | undefined

Inherited from

Metadata.getEngine

---

getFinalEngine()

getFinalEngine(): Engine | undefined

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

Returns

Engine | undefined

Inherited from

Metadata.getFinalEngine

---

getHistoryHash()

getHistoryHash(this): string | null

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

Parameters

this

TracksHistoryThis

Returns

string | null

Inherited from

Metadata.getHistoryHash

---

getIdAttribute()

getIdAttribute(): string

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

Returns

string

Inherited from

Metadata.getIdAttribute

---

getMalformedDocumentAttributes()

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

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

Returns

Record<string, string[]>

Inherited from

Metadata.getMalformedDocumentAttributes

---

getMetadataSchemaUpdates()

protected getMetadataSchemaUpdates(this, dirtyUrl): EngineAttributeUpdateOperation[]

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

Parameters

this

SolidModel

dirtyUrl

Nullable<string>

Returns

EngineAttributeUpdateOperation[]

Inherited from

Metadata.getMetadataSchemaUpdates

---

getOperationSchemaUpdates()

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

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

Parameters

this

SolidModel

model

SolidModel

removedFields

string[]

dirtyUrl

Nullable<string>

options

MigrateSchemaOptions

Returns

Promise<EngineAttributeUpdateOperation[]>

Inherited from

Metadata.getOperationSchemaUpdates

---

getOperationValue()

protected getOperationValue(this, field, value): unknown

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

Parameters

this

TracksHistoryThis

field

string

value

unknown

Returns

unknown

Inherited from

Metadata.getOperationValue

---

getOriginalAttribute()

getOriginalAttribute<T>(field): T

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

Type Parameters

T

T = unknown

Parameters

field

string

Returns

T

Inherited from

Metadata.getOriginalAttribute

---

getPrimaryKey()

getPrimaryKey(): Key | null

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

Returns

Key | null

Inherited from

Metadata.getPrimaryKey

---

getRelatedModels()

getRelatedModels(): SolidModel[]

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

Returns

SolidModel[]

Inherited from

Metadata.getRelatedModels

---

getRelation()

getRelation<T>(relation): T | null

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

Type Parameters

T

T extends Relation<Model, Model, ModelConstructor<Model>> = Relation<Model, Model, ModelConstructor<Model>>

Parameters

relation

string

Returns

T | null

Inherited from

Metadata.getRelation

---

getRelationModel()

Call Signature

getRelationModel<T>(relation): T | null

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

Type Parameters

T

T extends SolidModel

Parameters

relation

string

Returns

T | null

Inherited from

Metadata.getRelationModel

Call Signature

getRelationModel<T>(relation): T | null

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

Type Parameters

T

T extends Model

Parameters

relation

string

Returns

T | null

Inherited from

Metadata.getRelationModel

---

getRelationModels()

Call Signature

getRelationModels<T>(relation): T[] | null

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

Type Parameters

T

T extends SolidModel

Parameters

relation

string

Returns

T[] | null

Inherited from

Metadata.getRelationModels

Call Signature

getRelationModels<T>(relation): T[] | null

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

Type Parameters

T

T extends Model

Parameters

relation

string

Returns

T[] | null

Inherited from

Metadata.getRelationModels

---

getRemovedDocumentModels()

getRemovedDocumentModels(): SolidModel[]

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

Returns

SolidModel[]

Inherited from

Metadata.getRemovedDocumentModels

---

getResourceSchemaUpdate()

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

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

Parameters

this

SolidModel

model

SolidModel

dirtyUrl?

Nullable<string>

Returns

EngineAttributeUpdateOperation

Inherited from

Metadata.getResourceSchemaUpdate

---

getSchemaUpdates()

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

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModel

schema

SolidModelConstructor<T>

options

MigrateSchemaOptions

Returns

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

Inherited from

Metadata.getSchemaUpdates

---

getSerializedPrimaryKey()

getSerializedPrimaryKey(): string | null

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

Returns

string | null

Inherited from

Metadata.getSerializedPrimaryKey

---

getSourceContainerUrl()

getSourceContainerUrl(): string | null

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

Returns

string | null

Inherited from

Metadata.getSourceContainerUrl

---

getSourceDocumentUrl()

getSourceDocumentUrl(): string | null

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

Returns

string | null

Inherited from

Metadata.getSourceDocumentUrl

---

getUpdatedAtAttribute()

getUpdatedAtAttribute(): Date

Defined in: packages/soukai-solid/src/models/history/Metadata.ts:8

Returns

Date

Inherited from

Metadata.getUpdatedAtAttribute

---

getUrlSchemaUpdates()

protected getUrlSchemaUpdates(this, dirtyUrl): EngineAttributeUpdateOperation[]

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

Parameters

this

SolidModel

dirtyUrl

Nullable<string>

Returns

EngineAttributeUpdateOperation[]

Inherited from

Metadata.getUrlSchemaUpdates

---

guessCollection()

protected guessCollection(): string | undefined

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

Returns

string | undefined

Inherited from

Metadata.guessCollection

---

hasAttribute()

hasAttribute(field): boolean

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

Parameters

field

string

Returns

boolean

Inherited from

Metadata.hasAttribute

---

hasAttributeGetter()

hasAttributeGetter(field): boolean

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

Parameters

field

string

Returns

boolean

Inherited from

Metadata.hasAttributeGetter

---

hasAttributeSetter()

hasAttributeSetter(field): boolean

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

Parameters

field

string

Returns

boolean

Inherited from

Metadata.hasAttributeSetter

---

hasIncompleteAttributes()

hasIncompleteAttributes(): boolean

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

Returns

boolean

Inherited from

Metadata.hasIncompleteAttributes

---

hasMany()

Call Signature

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

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

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

Inherited from

Metadata.hasMany

Call Signature

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

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

Type Parameters

T

T extends typeof Model

Parameters

relatedClass

T

foreignKeyField?

string

localKeyField?

string

Returns

Relation

Inherited from

Metadata.hasMany

---

hasOne()

Call Signature

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

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

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

Inherited from

Metadata.hasOne

Call Signature

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

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

Type Parameters

T

T extends typeof Model

Parameters

relatedClass

T

foreignKeyField?

string

localKeyField?

string

Returns

Relation

Inherited from

Metadata.hasOne

---

hasRelation()

hasRelation(relation): boolean

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

Parameters

relation

string

Returns

boolean

Inherited from

Metadata.hasRelation

---

ignoreRdfPropertyHistory()

ignoreRdfPropertyHistory(rdfProperty, withSolidEngine?): boolean

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

Parameters

rdfProperty

string

withSolidEngine?

boolean

Returns

boolean

Inherited from

Metadata.ignoreRdfPropertyHistory

---

initialize()

protected initialize(attributes, exists): void

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

Parameters

attributes

Attributes

exists

boolean

Returns

void

Inherited from

Metadata.initialize

---

initializeAttributes()

protected initializeAttributes(attributes, exists): void

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

Parameters

attributes

Attributes

exists

boolean

Returns

void

Inherited from

Metadata.initializeAttributes

---

initializeMetadataRelation()

protected initializeMetadataRelation(): void

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

Returns

void

Inherited from

Metadata.initializeMetadataRelation

---

initializeProxy()

protected initializeProxy(): void

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

Returns

void

Inherited from

Metadata.initializeProxy

---

initializeRelations()

protected initializeRelations(): void

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

Returns

void

Inherited from

Metadata.initializeRelations

---

initializeRelationsEnabling()

protected initializeRelationsEnabling(): void

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

Returns

void

Inherited from

Metadata.initializeRelationsEnabling

---

is()

is(another): boolean

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

Parameters

another

this

Returns

boolean

Inherited from

Metadata.is

---

isContainedBy()

protected isContainedBy<T>(model): SolidIsContainedByRelation

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

Type Parameters

T

T extends typeof SolidContainer

Parameters

model

T

Returns

SolidIsContainedByRelation

Inherited from

Metadata.isContainedBy

---

isDirty()

isDirty(field?, ignoreRelations?): boolean

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

Parameters

field?

string

ignoreRelations?

boolean

Returns

boolean

Inherited from

Metadata.isDirty

---

isRelationLoaded()

isRelationLoaded(relation): boolean

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

Parameters

relation

string

Returns

boolean

Inherited from

Metadata.isRelationLoaded

---

isSoftDeleted()

isSoftDeleted(): boolean

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

Returns

boolean

Inherited from

Metadata.isSoftDeleted

---

leavesTombstone()

leavesTombstone(this): boolean

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

Parameters

this

TracksHistoryThis

Returns

boolean

Inherited from

Metadata.leavesTombstone

---

loadDocumentModels()

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

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

Parameters

documentUrl

string

document

EngineDocument

Returns

Promise<void>

Inherited from

Metadata.loadDocumentModels

---

loadEmptyRelations()

protected loadEmptyRelations(): Promise<void>

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

Returns

Promise<void>

Inherited from

Metadata.loadEmptyRelations

---

loadRelation()

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

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

Type Parameters

T

T extends Model | Model[] | null = Model | Model[] | null

Parameters

relation

string

Returns

Promise<T>

Inherited from

Metadata.loadRelation

---

loadRelationIfUnloaded()

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

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

Type Parameters

T

T extends Model | Model[] | null = Model | Model[] | null

Parameters

relation

string

Returns

Promise<T>

Inherited from

Metadata.loadRelationIfUnloaded

---

markAttributeDirty()

protected markAttributeDirty(field, originalValue, newValue): boolean

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

Parameters

field

string

originalValue

unknown

newValue

unknown

Returns

boolean

Inherited from

Metadata.markAttributeDirty

---

metadataRelationship()

metadataRelationship(): Relation

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

Returns

Relation

Inherited from

Metadata.metadataRelationship

---

migrateSchema()

migrateSchema<T>(this, schema, options?): Promise<T>

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModel

schema

SolidSchemaDefinition | SolidModelConstructor<T>

options?

MigrateSchemaOptions = {}

Returns

Promise<T>

Inherited from

Metadata.migrateSchema

---

mintDocumentModelsKeys()

protected mintDocumentModelsKeys(models): void

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

Parameters

models

SolidModel[]

Returns

void

Inherited from

Metadata.mintDocumentModelsKeys

---

mintUrl()

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

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

Parameters

documentUrl?

string

documentExists?

boolean

resourceHash?

string

Returns

void

Inherited from

Metadata.mintUrl

---

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: Attributes, _?: boolean]

Returns

T

Inherited from

Metadata.newInstance

---

newInstanceForSchema()

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

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModel

schema

SolidModelConstructor<T>

addedFields

string[]

removedFields

string[]

Returns

Promise<T>

Inherited from

Metadata.newInstanceForSchema

---

newUniqueUrl()

protected newUniqueUrl(url?): string

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

Parameters

url?

string

Returns

string

Inherited from

Metadata.newUniqueUrl

---

newUrl()

protected newUrl(documentUrl?, resourceHash?): string

Defined in: packages/soukai-solid/src/models/history/Metadata.ts:12

Parameters

documentUrl?

string

resourceHash?

string

Returns

string

Inherited from

Metadata.newUrl

---

newUrlDocumentUrl()

protected newUrlDocumentUrl(): string

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

Returns

string

Inherited from

Metadata.newUrlDocumentUrl

---

newUrlDocumentUrlSlug()

protected newUrlDocumentUrlSlug(): string | null

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

Returns

string | null

Inherited from

Metadata.newUrlDocumentUrlSlug

---

newUrlResourceHash()

protected newUrlResourceHash(): string | null

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

Returns

string | null

Inherited from

Metadata.newUrlResourceHash

---

onMoved()

onMoved(newResourceUrl, newDocumentUrl?): void

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

Parameters

newResourceUrl

string

newDocumentUrl?

string

Returns

void

Inherited from

Metadata.onMoved

---

onPrimaryKeyUpdated()

protected onPrimaryKeyUpdated(value, oldValue): void

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

Parameters

value

Key | null

oldValue

Key | null

Returns

void

Inherited from

Metadata.onPrimaryKeyUpdated

---

operationsRelationship()

operationsRelationship(): Relation

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

Returns

Relation

Inherited from

Metadata.operationsRelationship

---

parseEngineDocumentAttributes()

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

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

Parameters

id

Key

document

EngineDocument

resourceId?

string

Returns

Promise<Attributes>

Inherited from

Metadata.parseEngineDocumentAttributes

---

parseEngineDocumentAttributesFromJsonLD()

protected parseEngineDocumentAttributesFromJsonLD(this, document, resourceId): Promise<Attributes>

Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:33

Parameters

this

SolidModel

document

EngineDocument

resourceId

string

Returns

Promise<Attributes>

Inherited from

Metadata.parseEngineDocumentAttributesFromJsonLD

---

parseKey()

protected parseKey(key): Key

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

Parameters

key

string

Returns

Key

Inherited from

Metadata.parseKey

---

performDelete()

protected performDelete(): Promise<void>

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

Returns

Promise<void>

Inherited from

Metadata.performDelete

---

performMalformedAttributeFixes()

protected performMalformedAttributeFixes(): void

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

Returns

void

Inherited from

Metadata.performMalformedAttributeFixes

---

performSave()

protected performSave(): Promise<void>

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

Returns

Promise<void>

Inherited from

Metadata.performSave

---

populateCascadeModels()

protected populateCascadeModels(cascadeModels): Promise<void>

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

Parameters

cascadeModels

Set<Model>

Returns

Promise<void>

Inherited from

Metadata.populateCascadeModels

---

rebuildAttributesFromHistory()

rebuildAttributesFromHistory(this): void

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

Parameters

this

TracksHistoryThis

Returns

void

Inherited from

Metadata.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

Metadata.reconcileModelTimestamps

---

registerInTypeIndex()

registerInTypeIndex(typeIndexUrl): Promise<void>

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

Parameters

typeIndexUrl

string

Returns

Promise<void>

Inherited from

Metadata.registerInTypeIndex

---

removeDuplicatedHistoryOperations()

protected removeDuplicatedHistoryOperations(this): void

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

Parameters

this

TracksHistoryThis

Returns

void

Inherited from

Metadata.removeDuplicatedHistoryOperations

---

requireContainerUrl()

requireContainerUrl(): string

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

Returns

string

Inherited from

Metadata.requireContainerUrl

---

requireDocumentUrl()

requireDocumentUrl(): string

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

Returns

string

Inherited from

Metadata.requireDocumentUrl

---

requireEngine()

requireEngine<T>(): T

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

Type Parameters

T

T extends Engine

Returns

T

Inherited from

Metadata.requireEngine

---

requireFinalEngine()

requireFinalEngine<T>(): T

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

Type Parameters

T

T extends Engine

Returns

T

Inherited from

Metadata.requireFinalEngine

---

requireRelation()

Call Signature

requireRelation<T>(relation): T

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

Type Parameters

T

T extends SolidRelation = SolidRelation

Parameters

relation

string

Returns

T

Inherited from

Metadata.requireRelation

Call Signature

requireRelation<T>(relation): T

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

Type Parameters

T

T extends Relation<Model, Model, ModelConstructor<Model>> = Relation<Model, Model, ModelConstructor<Model>>

Parameters

relation

string

Returns

T

Inherited from

Metadata.requireRelation

---

reset()

reset(): void

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

Returns

void

Inherited from

Metadata.reset

---

resetEngineData()

protected resetEngineData(): void

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

Returns

void

Deprecated

use reset instead.

Inherited from

Metadata.resetEngineData

---

save()

save(collection?): Promise<Tombstone>

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

Parameters

collection?

string

Returns

Promise<Tombstone>

Inherited from

Metadata.save

---

saveInDocument()

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

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

Parameters

documentUrl

string

resourceHash?

string

Returns

Promise<Tombstone>

Inherited from

Metadata.saveInDocument

---

serializeKey()

protected serializeKey(key): string

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

Parameters

key

Key

Returns

string

Inherited from

Metadata.serializeKey

---

serializeToJsonLD()

protected serializeToJsonLD(this, options?): JsonLD

Defined in: packages/soukai-solid/src/models/mixins/SerializesToJsonLD.ts:27

Parameters

this

SolidModel

options?

SerializeOptions = {}

Returns

JsonLD

Inherited from

Metadata.serializeToJsonLD

---

setAttribute()

setAttribute(field, value): void

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

Parameters

field

string

value

unknown

Returns

void

Inherited from

Metadata.setAttribute

---

setAttributes()

setAttributes(attributes): void

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

Parameters

attributes

Attributes

Returns

void

Inherited from

Metadata.setAttributes

---

setAttributeValue()

setAttributeValue(field, value): void

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

Parameters

field

string

value

unknown

Returns

void

Inherited from

Metadata.setAttributeValue

---

setCreatedAtAttribute()

setCreatedAtAttribute(value): void

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

Parameters

value

unknown

Returns

void

Inherited from

Metadata.setCreatedAtAttribute

---

setDocumentExists()

setDocumentExists(documentExists): void

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

Parameters

documentExists

boolean

Returns

void

Inherited from

Metadata.setDocumentExists

---

setEngine()

setEngine(engine?): void

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

Parameters

engine?

Engine

Returns

void

Inherited from

Metadata.setEngine

---

setExists()

setExists(exists): void

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

Parameters

exists

boolean

Returns

void

Inherited from

Metadata.setExists

---

setMalformedDocumentAttributes()

setMalformedDocumentAttributes(malformedAttributes): void

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

Parameters

malformedAttributes

Record<string, string[]>

Returns

void

Inherited from

Metadata.setMalformedDocumentAttributes

---

setOriginalAttribute()

setOriginalAttribute(field, value): void

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

Parameters

field

string

value

unknown

Returns

void

Inherited from

Metadata.setOriginalAttribute

---

setRelationModel()

setRelationModel(relation, model): void

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

Parameters

relation

string

model

SolidModel | null

Returns

void

Inherited from

Metadata.setRelationModel

---

setRelationModels()

setRelationModels(relation, models): void

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

Parameters

relation

string

models

SolidModel[] | null

Returns

void

Inherited from

Metadata.setRelationModels

---

setSourceDocumentUrl()

setSourceDocumentUrl(sourceDocumentUrl): void

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

Parameters

sourceDocumentUrl

string | null

Returns

void

Inherited from

Metadata.setSourceDocumentUrl

---

setUpdatedAtAttribute()

setUpdatedAtAttribute(value): void

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

Parameters

value

unknown

Returns

void

Inherited from

Metadata.setUpdatedAtAttribute

---

softDelete()

softDelete(): Promise<Tombstone>

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

Returns

Promise<Tombstone>

Inherited from

Metadata.softDelete

---

static()

Call Signature

static(property): SolidBootedFieldsDefinition

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

Parameters

property

"fields"

Returns

SolidBootedFieldsDefinition

Inherited from

Metadata.static

Call Signature

static(property): TimestampFieldValue[]

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

Parameters

property

"timestamps"

Returns

TimestampFieldValue[]

Inherited from

Metadata.static

Call Signature

static<T>(): T

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

Type Parameters

T

T extends typeof SolidModel

Returns

T

Inherited from

Metadata.static

Call Signature

static<T, K>(property): T[K]

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

Type Parameters

T

T extends typeof SolidModel

K

K extends string | number | symbol

Parameters

property

K

Returns

T[K]

Inherited from

Metadata.static

---

syncDirty()

protected syncDirty(): Promise<string>

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

Returns

Promise<string>

Inherited from

Metadata.syncDirty

---

toEngineDocument()

protected toEngineDocument(): EngineDocument

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

Returns

EngineDocument

Inherited from

Metadata.toEngineDocument

---

toJsonLD()

toJsonLD(options?): Record<string, unknown>

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

Parameters

options?

SolidModelSerializationOptions = {}

Returns

Record<string, unknown>

Inherited from

Metadata.toJsonLD

---

tombstoneRelationship()

tombstoneRelationship(): Relation

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

Returns

Relation

Inherited from

Metadata.tombstoneRelationship

---

toTurtle()

toTurtle(options?): Promise<string>

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

Parameters

options?

SolidModelSerializationOptions = {}

Returns

Promise<string>

Inherited from

Metadata.toTurtle

---

touch()

touch(): void

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

Set the updatedAt attribute to the current time.

Returns

void

Inherited from

Metadata.touch

---

trackPublicPermissions()

protected trackPublicPermissions(this): PermissionsTracker

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

Parameters

this

SolidModel

Returns

PermissionsTracker

Inherited from

Metadata.trackPublicPermissions

---

tracksHistory()

tracksHistory(this): boolean

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

Parameters

this

TracksHistoryThis

Returns

boolean

Inherited from

Metadata.tracksHistory

---

unloadRelation()

unloadRelation(relation): void

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

Parameters

relation

string

Returns

void

Inherited from

Metadata.unloadRelation

---

unsetAttribute()

unsetAttribute(field): void

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

Parameters

field

string

Returns

void

Inherited from

Metadata.unsetAttribute

---

update()

update(attributes?): Promise<Tombstone>

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

Parameters

attributes?

Attributes

Returns

Promise<Tombstone>

Inherited from

Metadata.update

---

updateEngineDocumentSchema()

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

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

Parameters

this

SolidModel

graphUpdates

EngineAttributeUpdateOperation[]

Returns

Promise<void>

Inherited from

Metadata.updateEngineDocumentSchema

---

updatePublicPermissions()

updatePublicPermissions(this, permissions): Promise<void>

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

Parameters

this

SolidModel

permissions

SolidDocumentPermission[]

Returns

Promise<void>

Inherited from

Metadata.updatePublicPermissions

---

usesRdfAliases()

usesRdfAliases(): boolean

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

Returns

boolean

Inherited from

Metadata.usesRdfAliases

---

usingSolidEngine()

usingSolidEngine(): boolean

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

Returns

boolean

Inherited from

Metadata.usingSolidEngine

---

wasRecentlyCreated()

wasRecentlyCreated(): boolean

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

Returns

boolean

Inherited from

Metadata.wasRecentlyCreated

---

wasRecentlyDeleted()

wasRecentlyDeleted(): boolean

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

Returns

boolean

Inherited from

Metadata.wasRecentlyDeleted

---

withEngine()

Call Signature

withEngine(engine): this

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

Parameters

engine

Engine

Returns

this

Inherited from

Metadata.withEngine

Call Signature

withEngine<T>(engine, operation): T

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

Type Parameters

T

T

Parameters

engine

Engine

operation

(model) => T

Returns

T

Inherited from

Metadata.withEngine

Call Signature

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

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

Type Parameters

T

T

Parameters

engine

Engine

operation

(model) => Promise<T>

Returns

Promise<T>

Inherited from

Metadata.withEngine

---

withoutTimestamps()

withoutTimestamps<T>(operation): Promise<T>

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

Type Parameters

T

T

Parameters

operation

() => Promise<T>

Returns

Promise<T>

Inherited from

Metadata.withoutTimestamps

---

withoutTrackingHistory()

Call Signature

withoutTrackingHistory<T>(this, operation): T

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

Type Parameters

T

T

Parameters

this

TracksHistoryThis

operation

() => T

Returns

T

Inherited from

Metadata.withoutTrackingHistory

Call Signature

withoutTrackingHistory<T>(this, operation): Promise<T>

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

Type Parameters

T

T

Parameters

this

TracksHistoryThis

operation

() => Promise<T>

Returns

Promise<T>

Inherited from

Metadata.withoutTrackingHistory

---

aliasRdfPrefixes()

static aliasRdfPrefixes(aliases): void

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

Parameters

aliases

Record<string, string>

Returns

void

Inherited from

Metadata.aliasRdfPrefixes

---

all()

Call Signature

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

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

filters?

EngineFilters

Returns

Promise<T[]>

Inherited from

Metadata.all

Call Signature

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

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

filters?

EngineFilters

Returns

Promise<T[]>

Inherited from

Metadata.all

---

at()

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

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

parentUrl

string

Returns

SolidModelConstructor<T>

Inherited from

Metadata.at

---

boot()

static boot(name?): void

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

Parameters

name?

string

Returns

void

Inherited from

Metadata.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

Metadata.bootClassDefinitions

---

bootCollection()

protected static bootCollection(): string

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

Returns

string

Inherited from

Metadata.bootCollection

---

bootFields()

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

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

Parameters

fields

SolidFieldsDefinition | undefined

primaryKey

string

timestamps

TimestampFieldValue[]

fieldDefinitions

SolidBootedFieldsDefinition

Returns

object

fieldAliases

fieldAliases: Record<string, string>

fields

fields: BootedFieldsDefinition

Inherited from

Metadata.bootFields

---

bootHooks()

protected static bootHooks(hooks?): ModelHooks

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

Parameters

hooks?

ModelHooks

Returns

ModelHooks

Inherited from

Metadata.bootHooks

---

bootModelName()

protected static bootModelName(name?): string

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

Parameters

name?

string

Returns

string

Inherited from

Metadata.bootModelName

---

bootRdfContexts()

protected static bootRdfContexts(rdfContext, rdfContexts, rdfsClass, options?): RDFContexts

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

Parameters

rdfContext

string | null

rdfContexts

RDFContexts

rdfsClass

string | undefined

options?

modelClass?

typeof SolidModel

skipParentSchema?

boolean

Returns

RDFContexts

Inherited from

Metadata.bootRdfContexts

---

bootRdfsClasses()

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

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

Parameters

rdfsClass

string | null

rdfsClasses

string[] | null

rdfContexts

RDFContexts

initialClass?

typeof SolidModel

Returns

string[]

Inherited from

Metadata.bootRdfsClasses

---

bootRdfsClassesAliases()

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

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

Parameters

rdfsClassesAliases

string[][]

rdfContexts

RDFContexts

Returns

string[][]

Inherited from

Metadata.bootRdfsClassesAliases

---

bootTimestamps()

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

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

Parameters

timestamps

boolean | TimestampFieldValue[] | undefined

fieldDefinitions

BootedFieldsDefinition

Returns

TimestampFieldValue[]

Inherited from

Metadata.bootTimestamps

---

create()

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

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

attributes?

Attributes = {}

Returns

Promise<T>

Inherited from

Metadata.create

---

createFromEngineDocument()

Call Signature

static createFromEngineDocument<T>(this, id, document, resourceId?): Promise<T>

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

id

Key

document

EngineDocument

resourceId?

string

Returns

Promise<T>

Inherited from

Metadata.createFromEngineDocument

Call Signature

static createFromEngineDocument<T>(this, id, document): Promise<T>

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

id

Key

document

EngineDocument

Returns

Promise<T>

Inherited from

Metadata.createFromEngineDocument

---

createFromJsonLD()

static createFromJsonLD<T>(this, jsonld, baseUrl?, resourceId?): Promise<T>

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

jsonld

JsonLD

baseUrl?

string

resourceId?

string

Returns

Promise<T>

Inherited from

Metadata.createFromJsonLD

---

createInDocument()

static createInDocument<T>(this, attributes, documentUrl, resourceHash?): Promise<T>

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

attributes

Attributes

documentUrl

string

resourceHash?

string

Returns

Promise<T>

Inherited from

Metadata.createInDocument

---

createManyFromEngineDocuments()

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

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

documents

Record<string, EngineDocument>

Returns

Promise<T[]>

Inherited from

Metadata.createManyFromEngineDocuments

---

ensureBooted()

static ensureBooted<T>(this): void

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

Returns

void

Inherited from

Metadata.ensureBooted

---

exclusive()

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

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

Type Parameters

T

T

Parameters

operation

() => T | Promise<T>

Returns

Promise<T>

Inherited from

Metadata.exclusive

---

find()

Call Signature

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

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

id

Key

Returns

Promise<T | null>

Inherited from

Metadata.find

Call Signature

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

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

id

Key

Returns

Promise<T | null>

Inherited from

Metadata.find

---

findMatchingResourceIds()

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

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

Parameters

quads

Quad[]

baseUrl?

string

Returns

string[]

Inherited from

Metadata.findMatchingResourceIds

---

findOrFail()

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

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

id

Key

Returns

Promise<T>

Inherited from

Metadata.findOrFail

---

first()

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

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

filters?

EngineFilters

Returns

Promise<T | null>

Inherited from

Metadata.first

---

from()

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

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

parentUrl

string

Returns

SolidModelConstructor<T>

Inherited from

Metadata.from

---

getDefaultRdfContext()

protected static getDefaultRdfContext(rdfContexts?): string

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

Parameters

rdfContexts?

RDFContexts

Returns

string

Inherited from

Metadata.getDefaultRdfContext

---

getEngine()

static getEngine(): Engine | undefined

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

Returns

Engine | undefined

Inherited from

Metadata.getEngine

---

getFieldDefinition()

static getFieldDefinition(field, value?): SolidBootedFieldDefinition

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

Parameters

field

string

value?

unknown

Returns

SolidBootedFieldDefinition

Inherited from

Metadata.getFieldDefinition

---

getFieldRdfProperty()

static getFieldRdfProperty(field): string | null

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

Parameters

field

string

Returns

string | null

Inherited from

Metadata.getFieldRdfProperty

---

getFinalEngine()

static getFinalEngine(): Engine | undefined

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

Returns

Engine | undefined

Inherited from

Metadata.getFinalEngine

---

getRdfPropertyField()

static getRdfPropertyField(rdfProperty): string | null

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

Parameters

rdfProperty

string

Returns

string | null

Inherited from

Metadata.getRdfPropertyField

---

hasAutomaticTimestamp()

static hasAutomaticTimestamp(timestamp): boolean

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

Parameters

timestamp

TimestampFieldValue

Returns

boolean

Inherited from

Metadata.hasAutomaticTimestamp

---

hasAutomaticTimestamps()

static hasAutomaticTimestamps(): boolean

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

Returns

boolean

Inherited from

Metadata.hasAutomaticTimestamps

---

instance()

static instance<T>(this): T

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

Returns

T

Inherited from

Metadata.instance

---

newFromJsonLD()

static newFromJsonLD<T>(this, sourceJsonLD, baseUrl?, sourceResourceId?): Promise<T>

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

sourceJsonLD

JsonLD

baseUrl?

string

sourceResourceId?

string

Returns

Promise<T>

Inherited from

Metadata.newFromJsonLD

---

newInstance()

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

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

params

...[attributes: Attributes, _?: boolean]

Returns

T

Inherited from

Metadata.newInstance

---

on()

static on<TModel, TEvent>(this, event, listener): () => void

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

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

Inherited from

Metadata.on

---

performSchemaUpdate()

protected static performSchemaUpdate(schema): Promise<void>

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

Parameters

schema

SolidSchemaDefinition | SolidModelConstructor

Returns

Promise<void>

Inherited from

Metadata.performSchemaUpdate

---

prepareEngineFilters()

static prepareEngineFilters(filters?): EngineFilters

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

Parameters

filters?

EngineFilters = {}

Returns

EngineFilters

Inherited from

Metadata.prepareEngineFilters

---

pureInstance()

protected static pureInstance<T>(this): T

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

Type Parameters

T

T extends Model

Parameters

this

ModelConstructor<T>

Returns

T

Inherited from

Metadata.pureInstance

---

rdfTerm()

static rdfTerm(property, rdfContexts?): string

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

Parameters

property

string

rdfContexts?

RDFContexts

Returns

string

Inherited from

Metadata.rdfTerm

---

replaceRdfPrefixes()

static replaceRdfPrefixes(replacements): void

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

Parameters

replacements

Record<string, string>

Returns

void

Inherited from

Metadata.replaceRdfPrefixes

---

requireEngine()

static requireEngine<T>(): T

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

Type Parameters

T

T extends Engine = Engine

Returns

T

Inherited from

Metadata.requireEngine

---

requireFetch()

static requireFetch(): Fetch

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

Returns

Fetch

Inherited from

Metadata.requireFetch

---

requireFieldRdfProperty()

static requireFieldRdfProperty(field): string

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

Parameters

field

string

Returns

string

Inherited from

Metadata.requireFieldRdfProperty

---

requireFinalEngine()

static requireFinalEngine<T>(): T

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

Type Parameters

T

T extends Engine = Engine

Returns

T

Inherited from

Metadata.requireFinalEngine

---

resetRdfAliases()

static resetRdfAliases(): void

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

Returns

void

Inherited from

Metadata.resetRdfAliases

---

setEngine()

static setEngine(engine?): void

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

Parameters

engine?

Engine

Returns

void

Inherited from

Metadata.setEngine

---

synchronize()

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

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

Type Parameters

T

T extends SolidModel

Parameters

this

SolidModelConstructor<T>

a

T

b

T

options?

object & SynchronizeCloneOptions = {}

Returns

Promise<void>

Inherited from

Metadata.synchronize

---

updateSchema()

Call Signature

static updateSchema(schema): Promise<void>

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

Parameters

schema

SolidSchemaDefinition | SolidModelConstructor

Returns

Promise<void>

Inherited from

Metadata.updateSchema

Call Signature

static updateSchema(schema): Promise<void>

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

Parameters

schema

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

Returns

Promise<void>

Inherited from

Metadata.updateSchema

---

useSoftDeletes()

static useSoftDeletes(enabled): void

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

Parameters

enabled

boolean

Returns

void

Inherited from

Metadata.useSoftDeletes

---

usingSolidEngine()

static usingSolidEngine(): boolean

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

Returns

boolean

Inherited from

Metadata.usingSolidEngine

---

withCollection()

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

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

Type Parameters

Result

Result

Parameters

collection

string | undefined

operation

() => Result | Promise<Result>

Returns

Promise<Result>

Inherited from

Metadata.withCollection

---

withEngine()

Call Signature

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

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

Type Parameters

T

T

Parameters

this

T

engine

Engine

Returns

T

Inherited from

Metadata.withEngine

Call Signature

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

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

Type Parameters

T

T

Parameters

engine

Engine

operation

() => T

Returns

T

Inherited from

Metadata.withEngine

Call Signature

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

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

Type Parameters

T

T

Parameters

engine

Engine

operation

() => Promise<T>

Returns

Promise<T>

Inherited from

Metadata.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

Metadata.withoutTimestamps