Skip to content
unreal-orm-logo unreal-orm-logo unreal-orm
🚀 This documentation is for unreal-orm 1.0.0 alpha which requires SurrealDB 2.0 alpha SDK. For the stable version, see npm.

ModelInstance

ModelInstance<TData> = BaseTable<TData> & TData

Defined in: define/table/types/model.ts:226

Represents an instance of a model, combining the base table functionality with the specific data shape. This is the type you get back when you call new User({ ... }) or User.select(...).

Type Parameters

Section titled “Type Parameters”

TData

Section titled “TData”

TData extends Record<string, unknown>

The inferred shape of the model’s data.