EntitySchemaWithMeta <TName, TTableName, TEntity, TBase, TProperties, TClass>

Extended EntitySchema interface that carries additional type-level metadata (entity name, properties, table name). Returned by defineEntity() to provide strong type inference without explicit generics.

Hierarchy

• EntitySchema<TEntity, TBase, TClass>
  • EntitySchemaWithMeta

Index

Properties

• name
• properties
• tableName

Accessors

• class
• meta

Methods

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

Properties

readonlyname

name: TName

Overrides EntitySchema.name

Returns the entity class name.

readonlyproperties

properties: TProperties

Overrides EntitySchema.properties

readonlytableName

tableName: TTableName

Overrides EntitySchema.tableName

Returns the database table name.

Accessors

inheritedclass

• get class(): Class

• Inherited from EntitySchema.class

  Returns Class

inheritedmeta

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

• Inherited from EntitySchema.meta

  Returns the underlying EntityMetadata.

  ---

  Returns EntityMetadata<Entity, Class>

Methods

inheritedaddEmbedded

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

• Inherited from EntitySchema.addEmbedded

  Adds an embedded property to the entity schema.

  ---

  Parameters

  • name: EntityKey<TEntity>

  • options: EmbeddedOptions<TEntity, Target>

  Returns void

inheritedaddEnum

• addEnum(name, type, options): void

• Inherited from EntitySchema.addEnum

  Adds an enum property to the entity schema.

  ---

  Parameters

  • name: EntityKey<TEntity>

  • optionaltype: TypeType

  • options: EnumOptions<TEntity> = {}

  Returns void

inheritedaddHook

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

• Inherited from EntitySchema.addHook

  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

inheritedaddIndex

• addIndex<Key>(options): void

• Inherited from EntitySchema.addIndex

  Adds an index definition to the entity schema.

  ---

  Parameters

  • options: IndexOptions<TEntity, Key>

  Returns void

inheritedaddManyToMany

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

• Inherited from EntitySchema.addManyToMany

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

  ---

  Parameters

  • name: EntityKey<TEntity>

  • type: TypeType

  • options: ManyToManyOptions<TEntity, Target>

  Returns void

inheritedaddManyToOne

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

• Inherited from EntitySchema.addManyToOne

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

  ---

  Parameters

  • name: EntityKey<TEntity>

  • type: TypeType

  • options: ManyToOneOptions<TEntity, Target>

  Returns void

inheritedaddOneToMany

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

• Inherited from EntitySchema.addOneToMany

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

  ---

  Parameters

  • name: EntityKey<TEntity>

  • type: TypeType

  • options: OneToManyOptions<TEntity, Target>

  Returns void

inheritedaddOneToOne

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

• Inherited from EntitySchema.addOneToOne

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

  ---

  Parameters

  • name: EntityKey<TEntity>

  • type: TypeType

  • options: OneToOneOptions<TEntity, Target>

  Returns void

inheritedaddPrimaryKey

• addPrimaryKey(name, type, options): void

• Inherited from EntitySchema.addPrimaryKey

  Adds a primary key property to the entity schema.

  ---

  Parameters

  • name: EntityKey<TEntity>

  • type: TypeType

  • options: PrimaryKeyOptions<TEntity> = {}

  Returns void

inheritedaddProperty

• addProperty(name, type, options): void

• Inherited from EntitySchema.addProperty

  Adds a scalar property to the entity schema.

  ---

  Parameters

  • name: EntityKey<TEntity>

  • optionaltype: TypeType

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

  Returns void

inheritedaddSerializedPrimaryKey

• addSerializedPrimaryKey(name, type, options): void

• Inherited from EntitySchema.addSerializedPrimaryKey

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

  ---

  Parameters

  • name: EntityKey<TEntity>

  • type: TypeType

  • options: SerializedPrimaryKeyOptions<TEntity> = {}

  Returns void

inheritedaddUnique

• addUnique<Key>(options): void

• Inherited from EntitySchema.addUnique

  Adds a unique constraint definition to the entity schema.

  ---

  Parameters

  • options: UniqueOptions<TEntity, Key>

  Returns void

inheritedaddVersion

• addVersion(name, type, options): void

• Inherited from EntitySchema.addVersion

  Adds a version property for optimistic locking.

  ---

  Parameters

  • name: EntityKey<TEntity>

  • type: TypeType

  • options: PropertyOptions<TEntity> = {}

  Returns void

inheritednew

• new(...params): TEntity

• Inherited from EntitySchema.new

  Parameters

  • rest...params: ConstructorParameters<TClass>

  Returns TEntity

inheritedsetClass

• setClass(cls): void

• Inherited from EntitySchema.setClass

  Sets or replaces the entity class associated with this schema.

  ---

  Parameters

  • cls: TClass

  Returns void

inheritedsetCustomRepository

• setCustomRepository(repository): void

• Inherited from EntitySchema.setCustomRepository

  Sets a custom repository class for this entity.

  ---

  Parameters

  • repository: () => Constructor

  Returns void

inheritedsetExtends

• setExtends(base): void

• Inherited from EntitySchema.setExtends

  Sets the base entity that this schema extends.

  ---

  Parameters

  • base: EntityName

  Returns void