ModelStatic
ModelStatic<
TInstance,TFields,TOptions> =TInstance
Defined in: define/table/types/model.ts:137
Represents the static side of a model class (the class itself).
This includes the constructor, static properties like _tableName and _fields,
and static methods like create and the overloaded select.
Type Parameters
Section titled “Type Parameters”TInstance
Section titled “TInstance”TInstance extends ModelInstance<InferShapeFromFields<TFields>>
The type of a model instance.
TFields
Section titled “TFields”TFields extends Record<string, FieldDefinition<unknown>>
The field definitions for the model.
TOptions
Section titled “TOptions”TOptions extends TableDefineOptions<TFields>
The table definition options.
new ModelStatic(
data):TInstance
Defined in: define/table/types/model.ts:143
Represents the static side of a model class (the class itself).
This includes the constructor, static properties like _tableName and _fields,
and static methods like create and the overloaded select.
Parameters
Section titled “Parameters”InferShapeFromFields<TFields>
Returns
Section titled “Returns”TInstance
Methods
Section titled “Methods”create()
Section titled “create()”create<
T>(this,db,data):Promise<InstanceType<T>>
Defined in: define/table/types/model.ts:153
Type Parameters
Section titled “Type Parameters”T extends ModelStatic<TInstance, TFields, TOptions>
Parameters
Section titled “Parameters”T
Surreal
CreateData<TFields>
Returns
Section titled “Returns”Promise<InstanceType<T>>
delete()
Section titled “delete()”delete<
T>(this,db,id):Promise<void>
Defined in: define/table/types/model.ts:219
Type Parameters
Section titled “Type Parameters”T extends ModelStatic<TInstance, TFields, TOptions>
Parameters
Section titled “Parameters”T
Surreal
RecordId
Returns
Section titled “Returns”Promise<void>
getTableName()
Section titled “getTableName()”getTableName():
string
Defined in: define/table/types/model.ts:152
Returns
Section titled “Returns”string
merge()
Section titled “merge()”merge<
T>(this,db,id,data):Promise<InstanceType<T>>
Defined in: define/table/types/model.ts:225
Type Parameters
Section titled “Type Parameters”T extends ModelStatic<TInstance, TFields, TOptions>
Parameters
Section titled “Parameters”T
Surreal
RecordId
Partial<InferShapeFromFields<TFields>>
Returns
Section titled “Returns”Promise<InstanceType<T>>
select()
Section titled “select()”Call Signature
Section titled “Call Signature”select<
QueryOptions>(this,db,options):Promise<Record<string,unknown>[]>
Defined in: define/table/types/model.ts:162
Type Parameters
Section titled “Type Parameters”QueryOptions
Section titled “QueryOptions”QueryOptions extends SelectQueryOptions<InferShapeFromFields<TFields>>
Parameters
Section titled “Parameters”ModelStatic<TInstance, TFields, TOptions>
Surreal
options
Section titled “options”QueryOptions & object
Returns
Section titled “Returns”Promise<Record<string, unknown>[]>
Call Signature
Section titled “Call Signature”select<
QueryOptions>(this,db,options):Promise<undefined|Partial<InferShapeFromFields<TFields>>>
Defined in: define/table/types/model.ts:171
Type Parameters
Section titled “Type Parameters”QueryOptions
Section titled “QueryOptions”QueryOptions extends SelectQueryOptions<InferShapeFromFields<TFields>>
Parameters
Section titled “Parameters”ModelStatic<TInstance, TFields, TOptions>
Surreal
options
Section titled “options”QueryOptions & object
Returns
Section titled “Returns”Promise<undefined | Partial<InferShapeFromFields<TFields>>>
Call Signature
Section titled “Call Signature”select<
QueryOptions>(this,db,options):Promise<Partial<InferShapeFromFields<TFields>>[]>
Defined in: define/table/types/model.ts:180
Type Parameters
Section titled “Type Parameters”QueryOptions
Section titled “QueryOptions”QueryOptions extends SelectQueryOptions<InferShapeFromFields<TFields>>
Parameters
Section titled “Parameters”ModelStatic<TInstance, TFields, TOptions>
Surreal
options
Section titled “options”QueryOptions & object
Returns
Section titled “Returns”Promise<Partial<InferShapeFromFields<TFields>>[]>
Call Signature
Section titled “Call Signature”select<
QueryOptions>(this,db,options):Promise<undefined|TInstance>
Defined in: define/table/types/model.ts:189
Type Parameters
Section titled “Type Parameters”QueryOptions
Section titled “QueryOptions”QueryOptions extends SelectQueryOptions<InferShapeFromFields<TFields>>
Parameters
Section titled “Parameters”ModelStatic<TInstance, TFields, TOptions>
Surreal
options
Section titled “options”QueryOptions & object
Returns
Section titled “Returns”Promise<undefined | TInstance>
Call Signature
Section titled “Call Signature”select<
QueryOptions>(this,db,options):Promise<TInstance[]>
Defined in: define/table/types/model.ts:198
Type Parameters
Section titled “Type Parameters”QueryOptions
Section titled “QueryOptions”QueryOptions extends SelectQueryOptions<InferShapeFromFields<TFields>>
Parameters
Section titled “Parameters”ModelStatic<TInstance, TFields, TOptions>
Surreal
options
Section titled “options”QueryOptions & object
Returns
Section titled “Returns”Promise<TInstance[]>
Call Signature
Section titled “Call Signature”select(
this,db):Promise<TInstance[]>
Defined in: define/table/types/model.ts:207
Parameters
Section titled “Parameters”ModelStatic<TInstance, TFields, TOptions>
Surreal
Returns
Section titled “Returns”Promise<TInstance[]>
update()
Section titled “update()”update<
T>(this,db,id,data):Promise<InstanceType<T>>
Defined in: define/table/types/model.ts:212
Type Parameters
Section titled “Type Parameters”T extends ModelStatic<TInstance, TFields, TOptions>
Parameters
Section titled “Parameters”T
Surreal
RecordId
Partial<InferShapeFromFields<TFields>>
Returns
Section titled “Returns”Promise<InstanceType<T>>