EntitySchema <Entity, Base, Class>

Class-less entity definition that provides a programmatic API for defining entities without decorators.

Hierarchy

• EntitySchema
  • EntitySchemaWithMeta

Index

Constructors

• constructor

Properties

• REGISTRY

Accessors

• class
• meta
• name
• properties
• tableName

Methods

• addEmbedded
• addEnum
• addHook
• addIndex
• addManyToMany
• addManyToOne
• addOneToMany
• addOneToOne
• addPrimaryKey
• addProperty
• addSerializedPrimaryKey
• addUnique
• addVersion
• new
• setClass
• setCustomRepository
• setExtends
• fromMetadata
• is

Constructors

constructor

• new EntitySchema<Entity, Base, Class>(meta): EntitySchema<Entity, Base, Class>

• Parameters

  • meta: EntitySchemaMetadata<Entity, Base, Class>

  Returns EntitySchema<Entity, Base, Class>

Properties

staticREGISTRY

REGISTRY: Map<Partial<any>, EntitySchema<any, never, EntityCtor<any>>> = ...

When schema links the entity class via class option, this registry allows the lookup from opposite side, so we can use the class in entities option just like the EntitySchema instance.

Accessors

class

• get class(): Class

• Returns Class

meta

• get meta(): EntityMetadata<Entity, Class>

• Returns the underlying EntityMetadata.

  ---

  Returns EntityMetadata<Entity, Class>

name

• get name(): string | EntityName<Entity>

• Returns the entity class name.

  ---

  Returns string | EntityName<Entity>

properties

• get properties(): Record<string, any>

• Returns Record<string, any>

tableName

• get tableName(): string

• Returns the database table name.

  ---

  Returns string

Methods

addEmbedded

• addEmbedded<Target>(name, options): void

• Adds an embedded property to the entity schema.

  ---

  Parameters

  • name: EntityKey<Entity>

  • options: EmbeddedOptions<Entity, Target>

  Returns void

addEnum

• addEnum(name, type, options): void

• Adds an enum property to the entity schema.

  ---

  Parameters

  • name: EntityKey<Entity>

  • optionaltype: TypeType

  • options: EnumOptions<Entity> = {}

  Returns void

addHook

• addHook<T>(event, handler): this

• Adds a lifecycle hook handler to the entity schema. This method allows registering hooks after the entity is defined, which can be useful for avoiding circular type references.

  @example

  export const Article = defineEntity({
    name: 'Article',
    properties: { ... },
  });
  
  Article.addHook('beforeCreate', async args => {
    args.entity.slug = args.entity.title.toLowerCase();
  });

  ---

  Parameters

  • event: EventType | onInit | onLoad | beforeCreate | afterCreate | beforeUpdate | afterUpdate | beforeUpsert | afterUpsert | beforeDelete | afterDelete | beforeFlush | onFlush | afterFlush | beforeTransactionStart | afterTransactionStart | beforeTransactionCommit | afterTransactionCommit | beforeTransactionRollback | afterTransactionRollback

  • handler: (args) => void | Promise<void>

  Returns this

addIndex

• addIndex<Key>(options): void

• Adds an index definition to the entity schema.

  ---

  Parameters

  • options: IndexOptions<Entity, Key>

  Returns void

addManyToMany

• addManyToMany<Target>(name, type, options): void

• Adds a many-to-many relation to the entity schema.

  ---

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: ManyToManyOptions<Entity, Target>

  Returns void

addManyToOne

• addManyToOne<Target>(name, type, options): void

• Adds a many-to-one relation to the entity schema.

  ---

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: ManyToOneOptions<Entity, Target>

  Returns void

addOneToMany

• addOneToMany<Target>(name, type, options): void

• Adds a one-to-many relation to the entity schema.

  ---

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: OneToManyOptions<Entity, Target>

  Returns void

addOneToOne

• addOneToOne<Target>(name, type, options): void

• Adds a one-to-one relation to the entity schema.

  ---

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: OneToOneOptions<Entity, Target>

  Returns void

addPrimaryKey

• addPrimaryKey(name, type, options): void

• Adds a primary key property to the entity schema.

  ---

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: PrimaryKeyOptions<Entity> = {}

  Returns void

addProperty

• addProperty(name, type, options): void

• Adds a scalar property to the entity schema.

  ---

  Parameters

  • name: EntityKey<Entity>

  • optionaltype: TypeType

  • options: PropertyOptions<Entity> | EntityProperty<Entity, any> = {}

  Returns void

addSerializedPrimaryKey

• addSerializedPrimaryKey(name, type, options): void

• Adds a serialized primary key property (e.g. for MongoDB ObjectId).

  ---

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: SerializedPrimaryKeyOptions<Entity> = {}

  Returns void

addUnique

• addUnique<Key>(options): void

• Adds a unique constraint definition to the entity schema.

  ---

  Parameters

  • options: UniqueOptions<Entity, Key>

  Returns void

addVersion

• addVersion(name, type, options): void

• Adds a version property for optimistic locking.

  ---

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: PropertyOptions<Entity> = {}

  Returns void

new

• new(...params): Entity

• Parameters

  • rest...params: ConstructorParameters<Class>

  Returns Entity

setClass

• setClass(cls): void

• Sets or replaces the entity class associated with this schema.

  ---

  Parameters

  • cls: Class

  Returns void

setCustomRepository

• setCustomRepository(repository): void

• Sets a custom repository class for this entity.

  ---

  Parameters

  • repository: () => Constructor

  Returns void

setExtends

• setExtends(base): void

• Sets the base entity that this schema extends.

  ---

  Parameters

  • base: EntityName

  Returns void

staticfromMetadata

• fromMetadata<T, U>(meta): EntitySchema<T, U, EntityCtor<T>>

• Creates an EntitySchema from existing EntityMetadata (used internally).

  ---

  Parameters

  • meta: EntityMetadata<T, EntityCtor<T>> | DeepPartial<EntityMetadata<T, EntityCtor<T>>>

  Returns EntitySchema<T, U, EntityCtor<T>>

staticis

• is(item): item is EntitySchema<any, never, EntityCtor<any>>

• Checks if the given value is an EntitySchema instance, using duck-typing as a fallback when instanceof fails due to CJS/ESM dual-package hazard (e.g. when using tsx or @swc-node/register with "type": "commonjs" projects).

  ---

  Parameters

  • item: unknown

  Returns item is EntitySchema<any, never, EntityCtor<any>>