Class Bookmark

Exports the Bookmark class which extends the BookmarkSchema interface. This allows creating Bookmark instances with the required fields defined in BookmarkSchema.

Hierarchy

Constructors

constructor

Properties

_attributes _dirtyAttributes _documentExists _exists _malformedDocumentAttributes _originalAttributes _proxy _publicPermissions? _relations _removedResourceUrls _sourceDocumentUrl _trackedDirtyAttributes _usesRdfAliases _wasRecentlyCreated authorizations? created? creator? deletedAt? id link metadata operations relatedAuthorizations relatedMetadata relatedOperations relatedTombstone title tombstone? topic? updated? url __attributeGetters __attributeSetters classFields collection defaultResourceHash fields history historyDisabled mintsUrls modelName primaryKey rdfContext? rdfContexts rdfPropertyFields? rdfsClass? rdfsClasses rdfsClassesAliases relations reservedRelations timestamps tombstone

Accessors

isPrivate isPublic

Methods

addDirtyHistoryOperations addHistoryOperations afterSave attributeValueChanged authorizationsRelationship beforeCreate beforeDocumentSave beforeSave beforeUpdate belongsToMany belongsToOne callAttributeGetter callAttributeSetter castAttribute castAttributes cleanDirty clone convertEngineFiltersToJsonLD convertEngineUpdatesToJsonLD createFromEngineDocument createManyFromEngineDocuments delete deleteModels deleteModelsFromEngine disableHistory disableTombstone documentExists emit enableHistory enableTombstone exists fetchPublicPermissions fetchPublicPermissionsIfMissing fixMalformedAttributes fresh getAttribute getAttributeValue getAttributes getCascadeModels getContainerUrl getCreatedAtAttribute getDefaultCollection getDeletedAtAttribute getDirtyDocumentModels getDirtyEngineDocumentUpdates getDocumentModels getDocumentUrl getEngine getFinalEngine getHistoryHash getIdAttribute getMalformedDocumentAttributes getOriginalAttribute getPrimaryKey getRelatedModels getRelation getRelationModel getRelationModels getRemovedDocumentModels getSerializedPrimaryKey getSourceContainerUrl getSourceDocumentUrl getUpdatedAtAttribute guessCollection hasAttribute hasAttributeGetter hasAttributeSetter hasMany hasOne hasRelation initialize initializeAttributes initializeMetadataRelation initializeProxy initializeRelations initializeRelationsEnabling is isContainedBy isDirty isRelationLoaded isSoftDeleted leavesTombstone loadDocumentModels loadEmptyRelations loadRelation loadRelationIfUnloaded metadataRelationship mintDocumentModelsKeys mintUrl newInstance newUniqueUrl newUrl onMoved onPrimaryKeyUpdated operationsRelationship parseEngineDocumentAttributes parseEngineDocumentAttributesFromJsonLD parseKey performDelete performMalformedAttributeFixes performSave rebuildAttributesFromHistory registerInTypeIndex removeDuplicatedHistoryOperations requireContainerUrl requireDocumentUrl requireEngine requireFinalEngine requireRelation reset resetEngineData save saveInDocument serializeKey serializeToJsonLD setAttribute setAttributeValue setAttributes setCreatedAtAttribute setDocumentExists setEngine setExists setMalformedDocumentAttributes setOriginalAttribute setRelationModel setRelationModels setSourceDocumentUrl setUpdatedAtAttribute softDelete static syncDirty toEngineDocument toJsonLD toTurtle tombstoneRelationship touch trackPublicPermissions tracksHistory unloadRelation unsetAttribute update updatePublicPermissions usesRdfAliases wasRecentlyCreated withEngine withoutTimestamps withoutTrackingHistory aliasRdfPrefixes all at boot bootFields bootRdfContexts bootRdfsClasses create createFromEngineDocument createFromJsonLD createInDocument createManyFromEngineDocuments ensureBooted find findOrFail findResourceId first from getDefaultRdfContext getEngine getFieldDefinition getFieldRdfProperty getFinalEngine getRdfPropertyField hasAutomaticTimestamp hasAutomaticTimestamps instance newFromJsonLD newInstance on prepareEngineFilters pureInstance rdfTerm replaceRdfPrefixes requireEngine requireFetch requireFieldRdfProperty requireFinalEngine resetRdfAliases setEngine synchronize withCollection withEngine withoutTimestamps

Constructors

constructor

  • new Bookmark(attributes?, exists?): Bookmark

  • Parameters

    • Optional attributes: Attributes
    • Optional exists: boolean

    Returns Bookmark

Properties

Protected _attributes

_attributes: Attributes

Protected _dirtyAttributes

_dirtyAttributes: Attributes

Protected _documentExists

_documentExists: boolean

Protected _exists

_exists: boolean

Protected _malformedDocumentAttributes

_malformedDocumentAttributes: Record<string, string[]>

Protected _originalAttributes

_originalAttributes: Attributes

Protected _proxy

_proxy: Bookmark

Protected Optional _publicPermissions

_publicPermissions?: SolidDocumentPermission[]

Protected _relations

_relations: Record<string, SolidRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>>

Protected _removedResourceUrls

_removedResourceUrls: string[]

Protected _sourceDocumentUrl

_sourceDocumentUrl: null | string

Protected _trackedDirtyAttributes

_trackedDirtyAttributes: Attributes

Protected _usesRdfAliases

_usesRdfAliases: boolean

Protected _wasRecentlyCreated

_wasRecentlyCreated: boolean

Optional authorizations

authorizations?: SolidACLAuthorization[]

Optional created

created?: Date = ...

Optional creator

creator?: any = ...

Optional deletedAt

deletedAt?: Date

id

id: string

link

link: any = ...

metadata

metadata: Metadata

operations

operations: Operation[]

relatedAuthorizations

relatedAuthorizations: SolidACLAuthorizationsRelation<Bookmark>

relatedMetadata

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

relatedOperations

relatedOperations: OperationsRelation<Bookmark>

relatedTombstone

relatedTombstone: TombstoneRelation<Bookmark>

title

title: string = ...

Optional tombstone

tombstone?: Tombstone

Optional topic

topic?: any = ...

Optional updated

updated?: Date = ...

url

url: string

Static __attributeGetters

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

Type declaration

    • (): unknown

    • Returns unknown

Static __attributeSetters

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

Type declaration

    • (value): void

    • Parameters

      • value: unknown

      Returns void

Static classFields

classFields: string[]

Static collection

collection: string

Static defaultResourceHash

defaultResourceHash: string

Static fields

fields: SolidFieldsDefinition

Static history

history: boolean

Static Protected historyDisabled

historyDisabled: WeakMap<SolidModel, void>

Static mintsUrls

mintsUrls: boolean

Static modelName

modelName: string

Static primaryKey

primaryKey: string

Static Optional rdfContext

rdfContext?: string

Static rdfContexts

rdfContexts: Record<string, string>

Static Protected Optional rdfPropertyFields

rdfPropertyFields?: Record<string, string>

Static Optional rdfsClass

rdfsClass?: string

Static rdfsClasses

rdfsClasses: string[]

Static rdfsClassesAliases

rdfsClassesAliases: string[][]

Static relations

relations: string[]

Static reservedRelations

reservedRelations: string[]

Static timestamps

timestamps: TimestampsDefinition

Static tombstone

tombstone: boolean

Accessors

isPrivate

  • get isPrivate(): null | boolean

  • Returns null | boolean

isPublic

  • get isPublic(): null | boolean

  • Returns null | boolean

Methods

Protected addDirtyHistoryOperations

  • addDirtyHistoryOperations(): Promise<void>

  • Returns Promise<void>

Protected addHistoryOperations

  • addHistoryOperations(operations): void

  • Parameters

    • operations: Operation[]

    Returns void

Protected afterSave

  • afterSave(ignoreRelations?): Promise<void>

  • Parameters

    • Optional ignoreRelations: boolean

    Returns Promise<void>

Protected attributeValueChanged

  • attributeValueChanged(originalValue, newValue): boolean

  • Parameters

    • originalValue: unknown
    • newValue: unknown

    Returns boolean

authorizationsRelationship

  • authorizationsRelationship(): Relation<Model, Model, ModelConstructor<Model>>

  • Returns Relation<Model, Model, ModelConstructor<Model>>

Protected beforeCreate

  • beforeCreate(): Promise<void>

  • Returns Promise<void>

Protected beforeDocumentSave

  • beforeDocumentSave(): Promise<void>

  • Returns Promise<void>

Protected beforeSave

  • beforeSave(ignoreRelations?): Promise<void>

  • Parameters

    • Optional ignoreRelations: boolean

    Returns Promise<void>

Protected beforeUpdate

  • beforeUpdate(): Promise<void>

  • Returns Promise<void>

Protected belongsToMany

  • belongsToMany<T>(relatedClass, foreignKeyField?, localKeyField?): SolidBelongsToManyRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>

  • Type Parameters

    • T extends typeof SolidModel

    Parameters

    • relatedClass: T
    • Optional foreignKeyField: string
    • Optional localKeyField: string

    Returns SolidBelongsToManyRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>

  • belongsToMany<T>(relatedClass, foreignKeyField?, localKeyField?): Relation<Model, Model, ModelConstructor<Model>>

  • Type Parameters

    • T extends typeof Model

    Parameters

    • relatedClass: T
    • Optional foreignKeyField: string
    • Optional localKeyField: string

    Returns Relation<Model, Model, ModelConstructor<Model>>

Protected belongsToOne

  • belongsToOne<T>(relatedClass, foreignKeyField?, localKeyField?): SolidBelongsToOneRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>

  • Type Parameters

    • T extends typeof SolidModel

    Parameters

    • relatedClass: T
    • Optional foreignKeyField: string
    • Optional localKeyField: string

    Returns SolidBelongsToOneRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>

  • belongsToOne<T>(relatedClass, foreignKeyField?, localKeyField?): Relation<Model, Model, ModelConstructor<Model>>

  • Type Parameters

    • T extends typeof Model

    Parameters

    • relatedClass: T
    • Optional foreignKeyField: string
    • Optional localKeyField: string

    Returns Relation<Model, Model, ModelConstructor<Model>>

callAttributeGetter

  • callAttributeGetter(field): unknown

  • Parameters

    • field: string

    Returns unknown

callAttributeSetter

  • callAttributeSetter(field, value): void

  • Parameters

    • field: string
    • value: unknown

    Returns void

Protected castAttribute

  • castAttribute(value, options?): unknown

  • Parameters

    • value: unknown
    • Optional options: ModelCastAttributeOptions

    Returns unknown

Protected castAttributes

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

  • Parameters

    • attributes: Attributes
    • definitions: BootedFieldsDefinition<unknown>
    • Optional malformedAttributes: Record<string, string[]>
    • Optional fieldPrefix: string

    Returns Attributes

cleanDirty

  • cleanDirty(ignoreRelations?): void

  • Parameters

    • Optional ignoreRelations: boolean

    Returns void

clone

  • clone(options?): Bookmark

  • Parameters

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

    Returns Bookmark

  • clone<T>(options?): T

  • Type Parameters

    • T extends Model

    Parameters

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

    Returns T

Protected convertEngineFiltersToJsonLD

  • convertEngineFiltersToJsonLD(this, filters, compactIRIs): EngineFilters

  • Parameters

    • this: SolidModel
    • filters: EngineFilters
    • compactIRIs: boolean

    Returns EngineFilters

Protected convertEngineUpdatesToJsonLD

  • convertEngineUpdatesToJsonLD(this, updates, compactIRIs): EngineUpdates

  • Parameters

    • this: SolidModel
    • updates: EngineUpdates
    • compactIRIs: boolean

    Returns EngineUpdates

Protected createFromEngineDocument

  • createFromEngineDocument(id, document, resourceId?): Promise<Bookmark>

  • Parameters

    • id: any
    • document: EngineDocument
    • Optional resourceId: string

    Returns Promise<Bookmark>

Protected createManyFromEngineDocuments

  • createManyFromEngineDocuments(documents): Promise<Bookmark[]>

  • Parameters

    • documents: Record<string, EngineDocument>

    Returns Promise<Bookmark[]>

delete

  • delete(): Promise<Bookmark>

  • Returns Promise<Bookmark>

Protected deleteModels

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

  • Parameters

    • this: SolidModel
    • models: SolidModel[]

    Returns Promise<void>

Protected deleteModelsFromEngine

  • deleteModelsFromEngine(models): Promise<void>

  • Parameters

    Returns Promise<void>

disableHistory

  • disableHistory(): void

  • Returns void

disableTombstone

  • disableTombstone(): void

  • Returns void

documentExists

  • documentExists(): boolean

  • Returns boolean

Protected emit

  • emit(event): Promise<void>

  • Parameters

    • event: ModelEventValue

    Returns Promise<void>

enableHistory

  • enableHistory(): void

  • Returns void

enableTombstone

  • enableTombstone(): void

  • Returns void

exists

  • exists(): boolean

  • Returns boolean

fetchPublicPermissions

  • fetchPublicPermissions(this): Promise<void>

  • Parameters

    • this: SolidModel

    Returns Promise<void>

fetchPublicPermissionsIfMissing

  • fetchPublicPermissionsIfMissing(this): Promise<void>

  • Parameters

    • this: SolidModel

    Returns Promise<void>

fixMalformedAttributes

  • fixMalformedAttributes(): void

  • Returns void

fresh

  • fresh(): Promise<Bookmark>

  • Returns Promise<Bookmark>

getAttribute

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

  • Type Parameters

    • T = unknown

    Parameters

    • field: string
    • Optional includeUndefined: boolean

    Returns T

getAttributeValue

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

  • Type Parameters

    • T = unknown

    Parameters

    • field: string
    • Optional includeUndefined: boolean

    Returns T

getAttributes

  • getAttributes(includeUndefined?): Attributes

  • Parameters

    • Optional includeUndefined: boolean

    Returns Attributes

Protected getCascadeModels

  • getCascadeModels(): Promise<Model[]>

  • Returns Promise<Model[]>

getContainerUrl

  • getContainerUrl(): null | string

  • Returns null | string

getCreatedAtAttribute

  • getCreatedAtAttribute(): Date

  • Returns Date

Protected getDefaultCollection

  • getDefaultCollection(): string

  • Returns string

getDeletedAtAttribute

  • getDeletedAtAttribute(): undefined | Date

  • Returns undefined | Date

getDirtyDocumentModels

  • getDirtyDocumentModels(): SolidModel[]

  • Returns SolidModel[]

Protected getDirtyEngineDocumentUpdates

  • getDirtyEngineDocumentUpdates(ignoreRelations?): EngineUpdates

  • Parameters

    • Optional ignoreRelations: boolean

    Returns EngineUpdates

getDocumentModels

  • getDocumentModels(_documentModels?): SolidModel[]

  • Parameters

    • Optional _documentModels: Set<SolidModel>

    Returns SolidModel[]

getDocumentUrl

  • getDocumentUrl(): null | string

  • Returns null | string

getEngine

  • getEngine(): undefined | Engine

  • Returns undefined | Engine

getFinalEngine

  • getFinalEngine(): undefined | Engine

  • Returns undefined | Engine

getHistoryHash

  • getHistoryHash(): null | string

  • Returns null | string

getIdAttribute

  • getIdAttribute(): string

  • Returns string

getMalformedDocumentAttributes

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

  • Returns Record<string, string[]>

getOriginalAttribute

  • getOriginalAttribute<T>(field): T

  • Type Parameters

    • T = unknown

    Parameters

    • field: string

    Returns T

getPrimaryKey

  • getPrimaryKey(): any

  • Returns any

getRelatedModels

  • getRelatedModels(_relatedModels?): SolidModel[]

  • Parameters

    • Optional _relatedModels: Set<SolidModel>

    Returns SolidModel[]

getRelation

  • getRelation<T>(relation): null | T

  • Type Parameters

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

    Parameters

    • relation: string

    Returns null | T

getRelationModel

  • getRelationModel<T>(relation): null | T

  • Type Parameters

    • T extends SolidModel

    Parameters

    • relation: string

    Returns null | T

  • getRelationModel<T>(relation): null | T

  • Type Parameters

    • T extends Model

    Parameters

    • relation: string

    Returns null | T

getRelationModels

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • relation: string

    Returns null | T[]

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

  • Type Parameters

    • T extends Model

    Parameters

    • relation: string

    Returns null | T[]

getRemovedDocumentModels

  • getRemovedDocumentModels(): SolidModel[]

  • Returns SolidModel[]

getSerializedPrimaryKey

  • getSerializedPrimaryKey(): null | string

  • Returns null | string

getSourceContainerUrl

  • getSourceContainerUrl(): null | string

  • Returns null | string

getSourceDocumentUrl

  • getSourceDocumentUrl(): null | string

  • Returns null | string

getUpdatedAtAttribute

  • getUpdatedAtAttribute(): Date

  • Returns Date

Protected guessCollection

  • guessCollection(): undefined | string

  • Returns undefined | string

hasAttribute

  • hasAttribute(field): boolean

  • Parameters

    • field: string

    Returns boolean

hasAttributeGetter

  • hasAttributeGetter(field): boolean

  • Parameters

    • field: string

    Returns boolean

hasAttributeSetter

  • hasAttributeSetter(field): boolean

  • Parameters

    • field: string

    Returns boolean

Protected hasMany

  • hasMany<T>(relatedClass, foreignKeyField?, localKeyField?): SolidHasManyRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>

  • Type Parameters

    • T extends typeof SolidModel

    Parameters

    • relatedClass: T
    • Optional foreignKeyField: string
    • Optional localKeyField: string

    Returns SolidHasManyRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>

  • hasMany<T>(relatedClass, foreignKeyField?, localKeyField?): Relation<Model, Model, ModelConstructor<Model>>

  • Type Parameters

    • T extends typeof Model

    Parameters

    • relatedClass: T
    • Optional foreignKeyField: string
    • Optional localKeyField: string

    Returns Relation<Model, Model, ModelConstructor<Model>>

Protected hasOne

  • hasOne<T>(relatedClass, foreignKeyField?, localKeyField?): SolidHasOneRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>

  • Type Parameters

    • T extends typeof SolidModel

    Parameters

    • relatedClass: T
    • Optional foreignKeyField: string
    • Optional localKeyField: string

    Returns SolidHasOneRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>

  • hasOne<T>(relatedClass, foreignKeyField?, localKeyField?): Relation<Model, Model, ModelConstructor<Model>>

  • Type Parameters

    • T extends typeof Model

    Parameters

    • relatedClass: T
    • Optional foreignKeyField: string
    • Optional localKeyField: string

    Returns Relation<Model, Model, ModelConstructor<Model>>

hasRelation

  • hasRelation(relation): boolean

  • Parameters

    • relation: string

    Returns boolean

Protected initialize

  • initialize(attributes, exists): void

  • Parameters

    • attributes: Attributes
    • exists: boolean

    Returns void

Protected initializeAttributes

  • initializeAttributes(attributes, exists): void

  • Parameters

    • attributes: Attributes
    • exists: boolean

    Returns void

Protected initializeMetadataRelation

  • initializeMetadataRelation(): void

  • Returns void

Protected initializeProxy

  • initializeProxy(): void

  • Returns void

Protected initializeRelations

  • initializeRelations(): void

  • Returns void

Protected initializeRelationsEnabling

  • initializeRelationsEnabling(): void

  • Returns void

is

  • is(another): boolean

  • Parameters

    Returns boolean

Protected isContainedBy

  • isContainedBy<T>(model): SolidIsContainedByRelation<SolidModel, SolidContainer, SolidContainerConstructor<SolidContainer>>

  • Type Parameters

    • T extends typeof SolidContainer

    Parameters

    • model: T

    Returns SolidIsContainedByRelation<SolidModel, SolidContainer, SolidContainerConstructor<SolidContainer>>

isDirty

  • isDirty(field?, ignoreRelations?): boolean

  • Parameters

    • Optional field: string
    • Optional ignoreRelations: boolean

    Returns boolean

isRelationLoaded

  • isRelationLoaded(relation): boolean

  • Parameters

    • relation: string

    Returns boolean

isSoftDeleted

  • isSoftDeleted(): boolean

  • Returns boolean

leavesTombstone

  • leavesTombstone(): boolean

  • Returns boolean

Protected loadDocumentModels

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

  • Parameters

    • documentUrl: string
    • document: EngineDocument

    Returns Promise<void>

Protected loadEmptyRelations

  • loadEmptyRelations(): Promise<void>

  • Returns Promise<void>

loadRelation

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

  • Type Parameters

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

    Parameters

    • relation: string

    Returns Promise<T>

loadRelationIfUnloaded

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

  • Type Parameters

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

    Parameters

    • relation: string

    Returns Promise<T>

metadataRelationship

  • metadataRelationship(): Relation<Model, Model, ModelConstructor<Model>>

  • Returns Relation<Model, Model, ModelConstructor<Model>>

Protected mintDocumentModelsKeys

  • mintDocumentModelsKeys(models): void

  • Parameters

    • models: SolidModel[]

    Returns void

mintUrl

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

  • Parameters

    • Optional documentUrl: string
    • Optional documentExists: boolean
    • Optional resourceHash: string

    Returns void

newInstance

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

  • Type Parameters

    • T extends Model

    Parameters

    • this: T
    • Rest ...params: [attributes?: Attributes, exists?: boolean]

    Returns T

Protected newUniqueUrl

  • newUniqueUrl(url?): string

  • Parameters

    • Optional url: string

    Returns string

Protected newUrl

  • newUrl(documentUrl?, resourceHash?): string

  • Parameters

    • Optional documentUrl: string
    • Optional resourceHash: string

    Returns string

onMoved

  • onMoved(newResourceUrl, newDocumentUrl?): void

  • Parameters

    • newResourceUrl: string
    • Optional newDocumentUrl: string

    Returns void

Protected onPrimaryKeyUpdated

  • onPrimaryKeyUpdated(value, oldValue): void

  • Parameters

    • value: any
    • oldValue: any

    Returns void

operationsRelationship

  • operationsRelationship(): Relation<Model, Model, ModelConstructor<Model>>

  • Returns Relation<Model, Model, ModelConstructor<Model>>

Protected parseEngineDocumentAttributes

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

  • Parameters

    • id: any
    • document: EngineDocument
    • Optional resourceId: string

    Returns Promise<Attributes>

Protected parseEngineDocumentAttributesFromJsonLD

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

  • Parameters

    • this: SolidModel
    • document: EngineDocument
    • resourceId: string

    Returns Promise<Attributes>

Protected parseKey

  • parseKey(key): any

  • Parameters

    • key: string

    Returns any

Protected performDelete

  • performDelete(): Promise<void>

  • Returns Promise<void>

Protected performMalformedAttributeFixes

  • performMalformedAttributeFixes(): void

  • Returns void

Protected performSave

  • performSave(): Promise<void>

  • Returns Promise<void>

rebuildAttributesFromHistory

  • rebuildAttributesFromHistory(): void

  • Returns void

registerInTypeIndex

  • registerInTypeIndex(typeIndexUrl): Promise<void>

  • Parameters

    • typeIndexUrl: string

    Returns Promise<void>

Protected removeDuplicatedHistoryOperations

  • removeDuplicatedHistoryOperations(): void

  • Returns void

requireContainerUrl

  • requireContainerUrl(): string

  • Returns string

requireDocumentUrl

  • requireDocumentUrl(): string

  • Returns string

requireEngine

  • requireEngine<T>(): T

  • Type Parameters

    • T extends Engine

    Returns T

requireFinalEngine

  • requireFinalEngine<T>(): T

  • Type Parameters

    • T extends Engine

    Returns T

requireRelation

  • requireRelation<T>(relation): T

  • Type Parameters

    • T extends SolidRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>> = SolidRelation<SolidModel, SolidModel, SolidModelConstructor<SolidModel>>

    Parameters

    • relation: string

    Returns T

  • requireRelation<T>(relation): T

  • Type Parameters

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

    Parameters

    • relation: string

    Returns T

Protected reset

  • reset(): void

  • Returns void

Protected resetEngineData

  • resetEngineData(): void

  • Returns void

    Deprecated

    use reset instead.

save

  • save(collection?): Promise<Bookmark>

  • Parameters

    • Optional collection: string

    Returns Promise<Bookmark>

saveInDocument

  • saveInDocument(documentUrl, resourceHash?): Promise<Bookmark>

  • Parameters

    • documentUrl: string
    • Optional resourceHash: string

    Returns Promise<Bookmark>

Protected serializeKey

  • serializeKey(key): string

  • Parameters

    • key: any

    Returns string

Protected serializeToJsonLD

  • serializeToJsonLD(this, includeRelations?): JsonLD

  • Parameters

    • this: SolidModel
    • Optional includeRelations: boolean

    Returns JsonLD

setAttribute

  • setAttribute(field, value): void

  • Parameters

    • field: string
    • value: unknown

    Returns void

setAttributeValue

  • setAttributeValue(field, value): void

  • Parameters

    • field: string
    • value: unknown

    Returns void

setAttributes

  • setAttributes(attributes): void

  • Parameters

    • attributes: Attributes

    Returns void

setCreatedAtAttribute

  • setCreatedAtAttribute(value): void

  • Parameters

    • value: unknown

    Returns void

setDocumentExists

  • setDocumentExists(documentExists): void

  • Parameters

    • documentExists: boolean

    Returns void

setEngine

  • setEngine(engine?): void

  • Parameters

    • Optional engine: Engine

    Returns void

setExists

  • setExists(exists): void

  • Parameters

    • exists: boolean

    Returns void

setMalformedDocumentAttributes

  • setMalformedDocumentAttributes(malformedAttributes): void

  • Parameters

    • malformedAttributes: Record<string, string[]>

    Returns void

setOriginalAttribute

  • setOriginalAttribute(field, value): void

  • Parameters

    • field: string
    • value: unknown

    Returns void

setRelationModel

  • setRelationModel(relation, model): void

  • Parameters

    • relation: string
    • model: null | SolidModel

    Returns void

setRelationModels

  • setRelationModels(relation, models): void

  • Parameters

    • relation: string
    • models: null | SolidModel[]

    Returns void

setSourceDocumentUrl

  • setSourceDocumentUrl(sourceDocumentUrl): void

  • Parameters

    • sourceDocumentUrl: null | string

    Returns void

setUpdatedAtAttribute

  • setUpdatedAtAttribute(value): void

  • Parameters

    • value: unknown

    Returns void

softDelete

  • softDelete(): Promise<Bookmark>

  • Returns Promise<Bookmark>

static

  • static(): SolidModelConstructor<Bookmark>

  • Returns SolidModelConstructor<Bookmark>

  • static(property): SolidBootedFieldsDefinition

  • Parameters

    • property: "fields"

    Returns SolidBootedFieldsDefinition

  • static(property): TimestampFieldValue[]

  • Parameters

    • property: "timestamps"

    Returns TimestampFieldValue[]

  • static<T>(property): SolidModelConstructor<Bookmark>[T]

  • Type Parameters

    • T extends "at" | "find" | "all" | "on" | "history" | "prototype" | "from" | "first" | "fields" | "primaryKey" | "timestamps" | "collection" | "modelName" | "classFields" | "relations" | "__attributeGetters" | "__attributeSetters" | "boot" | "create" | "createFromEngineDocument" | "createManyFromEngineDocuments" | "findOrFail" | "newInstance" | "instance" | "hasAutomaticTimestamp" | "hasAutomaticTimestamps" | "getEngine" | "getFinalEngine" | "requireEngine" | "requireFinalEngine" | "setEngine" | "withEngine" | "withoutTimestamps" | "rdfContext" | "rdfContexts" | "rdfsClass" | "rdfsClasses" | "rdfsClassesAliases" | "defaultResourceHash" | "tombstone" | "reservedRelations" | "mintsUrls" | "getFieldDefinition" | "getFieldRdfProperty" | "getRdfPropertyField" | "requireFetch" | "requireFieldRdfProperty" | "aliasRdfPrefixes" | "resetRdfAliases" | "replaceRdfPrefixes" | "prepareEngineFilters" | "rdfTerm" | "newFromJsonLD" | "createFromJsonLD" | "createInDocument" | "synchronize"

    Parameters

    • property: T

    Returns SolidModelConstructor<Bookmark>[T]

Protected syncDirty

  • syncDirty(): Promise<string>

  • Returns Promise<string>

Protected toEngineDocument

  • toEngineDocument(): EngineDocument

  • Returns EngineDocument

toJsonLD

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

  • Parameters

    • Optional options: SolidModelSerializationOptions

    Returns Record<string, unknown>

toTurtle

  • toTurtle(options?): Promise<string>

  • Parameters

    • Optional options: SolidModelSerializationOptions

    Returns Promise<string>

tombstoneRelationship

  • tombstoneRelationship(): Relation<Model, Model, ModelConstructor<Model>>

  • Returns Relation<Model, Model, ModelConstructor<Model>>

touch

  • touch(): void

  • Set the updatedAt attribute to the current time.

    Returns void

Protected trackPublicPermissions

  • trackPublicPermissions(this): PermissionsTracker

  • Parameters

    • this: SolidModel

    Returns PermissionsTracker

tracksHistory

  • tracksHistory(): boolean

  • Returns boolean

unloadRelation

  • unloadRelation(relation): void

  • Parameters

    • relation: string

    Returns void

unsetAttribute

  • unsetAttribute(field): void

  • Parameters

    • field: string

    Returns void

update

  • update(attributes?): Promise<Bookmark>

  • Parameters

    • Optional attributes: Attributes

    Returns Promise<Bookmark>

updatePublicPermissions

  • updatePublicPermissions(this, permissions): Promise<void>

  • Parameters

    • this: SolidModel
    • permissions: SolidDocumentPermission[]

    Returns Promise<void>

usesRdfAliases

  • usesRdfAliases(): boolean

  • Returns boolean

wasRecentlyCreated

  • wasRecentlyCreated(): boolean

  • Returns boolean

withEngine

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

  • Type Parameters

    • T

    Parameters

    • engine: Engine
    • operation: ((model) => T)
        • (model): T

        • Parameters

          Returns T

    Returns T

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

  • Type Parameters

    • T

    Parameters

    • engine: Engine
    • operation: ((model) => Promise<T>)
        • (model): Promise<T>

        • Parameters

          Returns Promise<T>

    Returns Promise<T>

withoutTimestamps

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

  • Type Parameters

    • T

    Parameters

    • operation: (() => Promise<T>)
        • (): Promise<T>

        • Returns Promise<T>

    Returns Promise<T>

withoutTrackingHistory

  • withoutTrackingHistory<T>(operation): T

  • Type Parameters

    • T

    Parameters

    • operation: (() => T)
        • (): T

        • Returns T

    Returns T

  • withoutTrackingHistory<T>(operation): Promise<T>

  • Type Parameters

    • T

    Parameters

    • operation: (() => Promise<T>)
        • (): Promise<T>

        • Returns Promise<T>

    Returns Promise<T>

Static aliasRdfPrefixes

  • aliasRdfPrefixes(aliases): void

  • Parameters

    • aliases: Record<string, string>

    Returns void

Static all

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

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>
    • Optional filters: EngineFilters

    Returns Promise<T[]>

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • this: SolidModelConstructor<T>
    • Optional filters: EngineFilters

    Returns Promise<T[]>

Static at

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • this: SolidModelConstructor<T>
    • parentUrl: string

    Returns SolidModelConstructor<T>

Static boot

  • boot(name?): void

  • Parameters

    • Optional name: string

    Returns void

Static Protected bootFields

  • bootFields(): SolidBootedFieldsDefinition

  • Returns SolidBootedFieldsDefinition

Static Protected bootRdfContexts

  • bootRdfContexts(initialClass?, initialRdfContexts?): Record<string, string>

  • Parameters

    • Optional initialClass: typeof SolidModel
    • Optional initialRdfContexts: Record<string, string>

    Returns Record<string, string>

Static Protected bootRdfsClasses

  • bootRdfsClasses(initialClass?): string[]

  • Parameters

    • Optional initialClass: typeof SolidModel

    Returns string[]

Static create

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

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>
    • Optional attributes: Attributes

    Returns Promise<T>

Static createFromEngineDocument

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • this: SolidModelConstructor<T>
    • id: any
    • document: EngineDocument
    • Optional resourceId: string

    Returns Promise<T>

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

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>
    • id: any
    • document: EngineDocument

    Returns Promise<T>

Static createFromJsonLD

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • this: SolidModelConstructor<T>
    • jsonld: JsonLD
    • Optional baseUrl: string
    • Optional resourceId: string

    Returns Promise<T>

Static createInDocument

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • this: SolidModelConstructor<T>
    • attributes: Attributes
    • documentUrl: string
    • Optional resourceHash: string

    Returns Promise<T>

Static createManyFromEngineDocuments

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

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>
    • documents: Record<string, EngineDocument>

    Returns Promise<T[]>

Static Protected ensureBooted

  • ensureBooted<T>(this): void

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>

    Returns void

Static find

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

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>
    • id: any

    Returns Promise<null | T>

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • this: SolidModelConstructor<T>
    • id: any

    Returns Promise<null | T>

Static findOrFail

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

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>
    • id: any

    Returns Promise<T>

Static Protected findResourceId

  • findResourceId(quads, baseUrl?): string

  • Parameters

    • quads: Quad[]
    • Optional baseUrl: string

    Returns string

Static first

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

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>
    • Optional filters: EngineFilters

    Returns Promise<null | T>

Static from

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • this: SolidModelConstructor<T>
    • parentUrl: string

    Returns SolidModelConstructor<T>

Static Protected getDefaultRdfContext

  • getDefaultRdfContext(): string

  • Returns string

Static getEngine

  • getEngine(): undefined | Engine

  • Returns undefined | Engine

Static getFieldDefinition

  • getFieldDefinition(field, value?): SolidBootedFieldDefinition

  • Parameters

    • field: string
    • Optional value: unknown

    Returns SolidBootedFieldDefinition

Static getFieldRdfProperty

  • getFieldRdfProperty(field): null | string

  • Parameters

    • field: string

    Returns null | string

Static getFinalEngine

  • getFinalEngine(): undefined | Engine

  • Returns undefined | Engine

Static getRdfPropertyField

  • getRdfPropertyField(rdfProperty): null | string

  • Parameters

    • rdfProperty: string

    Returns null | string

Static hasAutomaticTimestamp

  • hasAutomaticTimestamp(timestamp): boolean

  • Parameters

    • timestamp: TimestampFieldValue

    Returns boolean

Static hasAutomaticTimestamps

  • hasAutomaticTimestamps(): boolean

  • Returns boolean

Static instance

  • instance<T>(this): T

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>

    Returns T

Static newFromJsonLD

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • this: SolidModelConstructor<T>
    • sourceJsonLD: JsonLD
    • Optional baseUrl: string
    • Optional sourceResourceId: string

    Returns Promise<T>

Static newInstance

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

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>
    • Rest ...params: [attributes?: Attributes, exists?: boolean]

    Returns T

Static on

  • on<T>(this, event, listener): (() => void)

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>
    • event: ModelEventValue
    • listener: ModelListener<T>

    Returns (() => void)

      • (): void

      • Returns void

Static prepareEngineFilters

  • prepareEngineFilters(filters?): EngineFilters

  • Parameters

    • Optional filters: EngineFilters

    Returns EngineFilters

Static Protected pureInstance

  • pureInstance<T>(this): T

  • Type Parameters

    • T extends Model

    Parameters

    • this: ModelConstructor<T>

    Returns T

Static rdfTerm

  • rdfTerm(property): string

  • Parameters

    • property: string

    Returns string

Static replaceRdfPrefixes

  • replaceRdfPrefixes(replacements): void

  • Parameters

    • replacements: Record<string, string>

    Returns void

Static requireEngine

  • requireEngine<T>(): T

  • Type Parameters

    • T extends Engine = Engine

    Returns T

Static requireFetch

  • requireFetch(): Fetch

  • Returns Fetch

Static requireFieldRdfProperty

  • requireFieldRdfProperty(field): string

  • Parameters

    • field: string

    Returns string

Static requireFinalEngine

  • requireFinalEngine<T>(): T

  • Type Parameters

    • T extends Engine = Engine

    Returns T

Static resetRdfAliases

  • resetRdfAliases(): void

  • Returns void

Static setEngine

  • setEngine(engine?): void

  • Parameters

    • Optional engine: Engine

    Returns void

Static synchronize

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

  • Type Parameters

    • T extends SolidModel

    Parameters

    • this: SolidModelConstructor<T>
    • a: T
    • b: T

    Returns Promise<void>

Static Protected withCollection

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

  • Type Parameters

    • Result

    Parameters

    • Optional collection: string | (() => Result | Promise<Result>)
    • Optional operation: (() => Result | Promise<Result>)
        • (): Result | Promise<Result>

        • Returns Result | Promise<Result>

    Returns Promise<Result>

Static withEngine

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

  • Type Parameters

    • T

    Parameters

    • engine: Engine
    • operation: (() => T)
        • (): T

        • Returns T

    Returns T

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

  • Type Parameters

    • T

    Parameters

    • engine: Engine
    • operation: (() => Promise<T>)
        • (): Promise<T>

        • Returns Promise<T>

    Returns Promise<T>

Static withoutTimestamps

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

  • Type Parameters

    • T

    Parameters

    • operation: (() => Promise<T>)
        • (): Promise<T>

        • Returns Promise<T>

    Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc