EntitySchema <Entity, Base, Class>

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

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 EntityMetadata<Entity, Class>

name

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

• Returns string | EntityName<Entity>

properties

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

• Returns Record<string, any>

tableName

• get tableName(): string

• Returns string

Methods

addEmbedded

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

• Parameters

  • name: EntityKey<Entity>

  • options: EmbeddedOptions<Entity, Target>

  Returns void

addEnum

• addEnum(name, type, options): void

• Parameters

  • name: EntityKey<Entity>

  • optionaltype: TypeType

  • options: EnumOptions<Entity> = {}

  Returns void

addHook

• addHook<Event>(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: Event

  • handler: NonNullable<EventSubscriber<Entity>[Event]>

  Returns this

addIndex

• addIndex<Key>(options): void

• Parameters

  • options: IndexOptions<Entity, Key>

  Returns void

addManyToMany

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

• Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: ManyToManyOptions<Entity, Target>

  Returns void

addManyToOne

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

• Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: ManyToOneOptions<Entity, Target>

  Returns void

addOneToMany

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

• Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: OneToManyOptions<Entity, Target>

  Returns void

addOneToOne

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

• Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: OneToOneOptions<Entity, Target>

  Returns void

addPrimaryKey

• addPrimaryKey(name, type, options): void

• Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: PrimaryKeyOptions<Entity> = {}

  Returns void

addProperty

• addProperty(name, type, options): void

• Parameters

  • name: EntityKey<Entity>

  • optionaltype: TypeType

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

  Returns void

addSerializedPrimaryKey

• addSerializedPrimaryKey(name, type, options): void

• Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: SerializedPrimaryKeyOptions<Entity> = {}

  Returns void

addUnique

• addUnique<Key>(options): void

• Parameters

  • options: UniqueOptions<Entity, Key>

  Returns void

addVersion

• addVersion(name, type, options): void

• 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

• Parameters

  • cls: Class

  Returns void

setCustomRepository

• setCustomRepository(repository): void

• Parameters

  • repository: () => Constructor

  Returns void

setExtends

• setExtends(base): void

• Parameters

  • base: EntityName

  Returns void

staticfromMetadata

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

• Parameters

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

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