Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Model

Hierarchy

  • Model

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _attributes

_attributes: Attributes

Protected _dirtyAttributes

_dirtyAttributes: Attributes

Protected _exists

_exists: boolean

Protected _malformedDocumentAttributes

_malformedDocumentAttributes: Record<string, string[]>

Protected _originalAttributes

_originalAttributes: Attributes

Protected _proxy

_proxy: Model

Protected _relations

_relations: {}

Type declaration

Protected _wasRecentlyCreated

_wasRecentlyCreated: boolean

id

id: string

Static __attributeGetters

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

Static __attributeSetters

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

Static classFields

classFields: string[] = []

Static collection

collection: string

Static fields

fields: FieldsDefinition<unknown>

Static modelName

modelName: string

Static primaryKey

primaryKey: string = 'id'

Static relations

relations: string[] = []

Static timestamps

timestamps: TimestampsDefinition

Methods

Protected afterSave

  • afterSave(): Promise<void>

Protected attributeValueChanged

  • attributeValueChanged(originalValue: unknown, newValue: unknown): boolean

Protected beforeSave

  • beforeSave(): Promise<void>

Protected belongsToMany

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

    Type Parameters

    Parameters

    • relatedClass: T

      Related model class.

    • Optional foreignKeyField: string

      Name of the foreign key field in the local model.

    • Optional 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 BelongsToManyRelation<Model, Model, ModelConstructor<Model>>

Protected belongsToOne

  • Creates a relation when this model references one instance of another model.

    Type Parameters

    Parameters

    • relatedClass: T

      Related model class.

    • Optional foreignKeyField: string

      Name of the foreign key field in the local model.

    • Optional 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 BelongsToOneRelation<Model, Model, ModelConstructor<Model>>

callAttributeGetter

  • callAttributeGetter(field: string): unknown

callAttributeSetter

  • callAttributeSetter(field: string, value: unknown): void

Protected castAttribute

Protected castAttributes

cleanDirty

  • cleanDirty(): void

clone

  • clone(options?: Partial<{ clean: boolean; clones: WeakMap<Model, Model>; constructors: WeakMap<typeof Model, typeof Model> | [typeof Model, typeof Model][] }>): Model
  • clone<T>(options?: Partial<{ clean: boolean; clones: WeakMap<Model, Model>; constructors: WeakMap<typeof Model, typeof Model> | [typeof Model, typeof Model][] }>): T

Protected createFromEngineDocument

Protected createManyFromEngineDocuments

delete

Protected deleteModelsFromEngine

  • deleteModelsFromEngine(models: Model[]): Promise<void>

Protected emit

exists

  • exists(): boolean

fixMalformedAttributes

  • fixMalformedAttributes(): void

fresh

getAttribute

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

  • Type Parameters

    • T = unknown

    Parameters

    • field: string
    • includeUndefined: boolean = false

    Returns T

getAttributeValue

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

  • Type Parameters

    • T = unknown

    Parameters

    • field: string
    • includeUndefined: boolean = false

    Returns T

getAttributes

  • getAttributes(includeUndefined?: boolean): Attributes

Protected getCascadeModels

  • getCascadeModels(): Promise<Model[]>

Protected getDefaultCollection

  • getDefaultCollection(): string

Protected getDirtyEngineDocumentUpdates

getEngine

  • getEngine(): undefined | Engine

getFinalEngine

  • getFinalEngine(): undefined | Engine

getMalformedDocumentAttributes

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

getOriginalAttribute

  • getOriginalAttribute<T>(field: string): T

getPrimaryKey

  • getPrimaryKey(): any

getRelation

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

getRelationModel

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

getRelationModels

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

getSerializedPrimaryKey

  • getSerializedPrimaryKey(): null | string

hasAttribute

  • hasAttribute(field: string): boolean

hasAttributeGetter

  • hasAttributeGetter(field: string): boolean

hasAttributeSetter

  • hasAttributeSetter(field: string): boolean

Protected hasMany

  • Creates a relation when this model is referenced by multiple instances of another model.

    Type Parameters

    Parameters

    • relatedClass: T

      Related model class.

    • Optional foreignKeyField: string

      Name of the foreign key field in the related model.

    • Optional 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 HasManyRelation<Model, Model, ModelConstructor<Model>>

Protected hasOne

  • Creates a relation when this model is referenced by one instance of another model.

    Type Parameters

    Parameters

    • relatedClass: T

      Related model class.

    • Optional foreignKeyField: string

      Name of the foreign key field in the related model.

    • Optional 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 HasOneRelation<Model, Model, ModelConstructor<Model>>

hasRelation

  • hasRelation(relation: string): boolean

Protected initialize

  • initialize(attributes: Attributes, exists: boolean): void

Protected initializeAttributes

  • initializeAttributes(attributes: Attributes, exists: boolean): void

Protected initializeProxy

  • initializeProxy(): void

Protected initializeRelations

  • initializeRelations(): void

is

  • is(another: Model): boolean

isDirty

  • isDirty(field?: string): boolean

isRelationLoaded

  • isRelationLoaded(relation: string): boolean

Protected loadEmptyRelations

  • loadEmptyRelations(): Promise<void>

loadRelation

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

loadRelationIfUnloaded

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

newInstance

  • newInstance<T>(this: T, ...params: [attributes: Attributes, exists: boolean]): T

Protected parseEngineDocumentAttributes

Protected parseKey

  • parseKey(key: string): any

Protected performDelete

  • performDelete(): Promise<void>

Protected performMalformedAttributeFixes

  • performMalformedAttributeFixes(): void

Protected performSave

  • performSave(): Promise<void>

requireEngine

  • requireEngine<T>(): T

requireFinalEngine

  • requireFinalEngine<T>(): T

requireRelation

  • requireRelation<T>(relation: string): T

Protected reset

  • reset(): void

Protected resetEngineData

  • resetEngineData(): void

save

Protected serializeKey

  • serializeKey(key: any): string

setAttribute

  • setAttribute(field: string, value: unknown): void

setAttributeValue

  • setAttributeValue(field: string, value: unknown): void

setAttributes

setEngine

  • setEngine(engine?: Engine): void

setExists

  • setExists(exists: boolean): void

setMalformedDocumentAttributes

  • setMalformedDocumentAttributes(malformedAttributes: Record<string, string[]>): void

setOriginalAttribute

  • setOriginalAttribute(field: string, value: unknown): void

setRelationModel

  • setRelationModel(relation: string, model: null | Model): void

setRelationModels

  • setRelationModels(relation: string, models: null | Model[]): void

static

  • Returns ModelConstructor<Model>

  • Parameters

    • property: "fields"

    Returns BootedFieldsDefinition<unknown>

  • Type Parameters

    • T extends "fields" | "prototype" | "collection" | "primaryKey" | "timestamps" | "modelName" | "classFields" | "relations" | "__attributeGetters" | "__attributeSetters" | "boot" | "create" | "createFromEngineDocument" | "createManyFromEngineDocuments" | "findOrFail" | "find" | "all" | "first" | "newInstance" | "on" | "instance" | "hasAutomaticTimestamp" | "hasAutomaticTimestamps" | "getEngine" | "getFinalEngine" | "requireEngine" | "requireFinalEngine" | "setEngine" | "withEngine" | "withoutTimestamps"

    Parameters

    • property: T

    Returns ModelConstructor<Model>[T]

Protected syncDirty

  • syncDirty(): Promise<string>

Protected toEngineDocument

touch

  • touch(): void

unloadRelation

  • unloadRelation(relation: string): void

unsetAttribute

  • unsetAttribute(field: string): void

update

wasRecentlyCreated

  • wasRecentlyCreated(): boolean

withEngine

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

withoutTimestamps

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

  • Type Parameters

    • T

    Parameters

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

        • Returns Promise<T>

    Returns Promise<T>

Static all

Static boot

Static create

Static createFromEngineDocument

Static createManyFromEngineDocuments

Static Protected ensureBooted

Static find

Static findOrFail

Static first

Static getEngine

  • getEngine(): undefined | Engine

Static getFinalEngine

  • getFinalEngine(): undefined | Engine

Static hasAutomaticTimestamp

Static hasAutomaticTimestamps

  • hasAutomaticTimestamps(): boolean

Static instance

Static newInstance

Static on

Static Protected pureInstance

Static requireEngine

  • requireEngine<T>(): T

Static requireFinalEngine

  • requireFinalEngine<T>(): T

Static setEngine

  • setEngine(engine?: Engine): void

Static withEngine

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

Static withoutTimestamps

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

  • Type Parameters

    • T

    Parameters

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

        • Returns Promise<T>

    Returns Promise<T>

Generated using TypeDoc