Skip to main content

ModelClass

@webda/core

Interface: ModelClass<S>

Defined in: packages/models/lib/storable.d.ts:93

Constructor interface for Model classes.

Provides static methods for CRUD operations, querying, and serialization.

Type Parameters​

S​

S extends Storable = Storable

Constructors​

Constructor​

new ModelClass(arg): S

Defined in: packages/models/lib/storable.d.ts:94

Parameters​

arg​

any

Returns​

S

Properties​

prototype​

prototype: S

Defined in: packages/models/lib/storable.d.ts:95

Methods​

create()​

create<T>(this, data, save?): Promise<InstanceType<T>>

Defined in: packages/models/lib/storable.d.ts:98

Type Parameters​

T​

T extends ModelClass<Storable<any, any>>

Parameters​

this​

T

data​

ConstructorParameters<T>[0]

save?​

boolean

Returns​

Promise<InstanceType<T>>

getDeserializers()​

getDeserializers<T>(): Partial<Record<keyof InstanceType<T>, (value) => any>>

Defined in: packages/models/lib/storable.d.ts:104

Type Parameters​

T​

T extends ModelClass<Storable<any, any>>

Returns​

Partial<Record<keyof InstanceType<T>, (value) => any>>

iterate()​

iterate<T>(this, query, params?): AsyncGenerator<InstanceType<T>, any, any>

Defined in: packages/models/lib/storable.d.ts:97

Type Parameters​

T​

T extends ModelClass<Storable<any, any>>

Parameters​

this​

T

query​

string

params?​

QueryParameters

Returns​

AsyncGenerator<InstanceType<T>, any, any>

query()​

query<T>(this, query, params?): Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

Defined in: packages/models/lib/storable.d.ts:99

Type Parameters​

T​

T extends ModelClass<Storable<any, any>>

Parameters​

this​

T

query​

string

params?​

QueryParameters

Returns​

Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

ref()​

ref<T>(this, key): ModelRefWithCreate<InstanceType<T>>

Defined in: packages/models/lib/storable.d.ts:96

Type Parameters​

T​

T extends ModelClass<Storable<any, any>>

Parameters​

this​

T

key​

SettablePrimaryKey<InstanceType<T>>

Returns​

ModelRefWithCreate<InstanceType<T>>

registerSerializer()​

registerSerializer(overwrite?, identifier?): void

Defined in: packages/models/lib/storable.d.ts:103

Parameters​

overwrite?​

boolean

identifier?​

string

Returns​

void