EntitySchema <Entity, Base>

Index

Constructors

• constructor

Properties

• REGISTRY

Accessors

• meta
• name

Methods

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

Constructors

constructor

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

• Type parameters

  • Entity = any
  • Base = never

  Parameters

  • meta: EntitySchemaMetadata<Entity, Base>

  Returns EntitySchema<Entity, Base>

Properties

staticREGISTRY

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

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

meta

• get meta(): EntityMetadata<Entity>

• Returns EntityMetadata<Entity>

name

• get name(): EntityName<Entity>

• Returns EntityName<Entity>

Methods

addEmbedded

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

• Type parameters

  • Target = Partial<any>

  Parameters

  • name: EntityKey<Entity>

  • options: EmbeddedOptions

  Returns void

addEnum

• addEnum(name: EntityKey<Entity>, type?: TypeType, options?: EnumOptions<Entity>): void

• Parameters

  • name: EntityKey<Entity>

  • optionaltype: TypeType

  • options: EnumOptions<Entity> = {}

  Returns void

addIndex

• addIndex(options: IndexOptions<Entity>): void

• Parameters

  • options: IndexOptions<Entity>

  Returns void

addManyToMany

• addManyToMany<Target>(name: EntityKey<Entity>, type: TypeType, options: ManyToManyOptions<Entity, Target>): void

• Type parameters

  • Target = Partial<any>

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: ManyToManyOptions<Entity, Target>

  Returns void

addManyToOne

• addManyToOne<Target>(name: EntityKey<Entity>, type: TypeType, options: ManyToOneOptions<Entity, Target>): void

• Type parameters

  • Target = Partial<any>

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: ManyToOneOptions<Entity, Target>

  Returns void

addOneToMany

• addOneToMany<Target>(name: EntityKey<Entity>, type: TypeType, options: OneToManyOptions<Entity, Target>): void

• Type parameters

  • Target = Partial<any>

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: OneToManyOptions<Entity, Target>

  Returns void

addOneToOne

• addOneToOne<Target>(name: EntityKey<Entity>, type: TypeType, options: OneToOneOptions<Entity, Target>): void

• Type parameters

  • Target = Partial<any>

  Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: OneToOneOptions<Entity, Target>

  Returns void

addPrimaryKey

• addPrimaryKey(name: EntityKey<Entity>, type: TypeType, options?: PrimaryKeyOptions<Entity>): void

• Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: PrimaryKeyOptions<Entity> = {}

  Returns void

addProperty

• addProperty(name: EntityKey<Entity>, type?: TypeType, options?: PropertyOptions<Entity> | EntityProperty<Entity, any>): void

• Parameters

  • name: EntityKey<Entity>

  • optionaltype: TypeType

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

  Returns void

addSerializedPrimaryKey

• addSerializedPrimaryKey(name: EntityKey<Entity>, type: TypeType, options?: SerializedPrimaryKeyOptions<Entity>): void

• Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: SerializedPrimaryKeyOptions<Entity> = {}

  Returns void

addUnique

• addUnique(options: UniqueOptions<Entity>): void

• Parameters

  • options: UniqueOptions<Entity>

  Returns void

addVersion

• addVersion(name: EntityKey<Entity>, type: TypeType, options?: PropertyOptions<Entity>): void

• Parameters

  • name: EntityKey<Entity>

  • type: TypeType

  • options: PropertyOptions<Entity> = {}

  Returns void

setClass

• setClass(proto: EntityClass<Entity>): void

• Parameters

  • proto: EntityClass<Entity>

  Returns void

setCustomRepository

• setCustomRepository(repository: () => Constructor): void

• Parameters

  • repository: () => Constructor

  Returns void

setExtends

• setExtends(base: string | EntitySchema<any, never>): void

• Parameters

  • base: string | EntitySchema<any, never>

  Returns void

staticfromMetadata

• fromMetadata<T, U>(meta: EntityMetadata<T> | DeepPartial<EntityMetadata<T>>): EntitySchema<T, U>

• Type parameters

  • T = Partial<any>
  • U = never

  Parameters

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

  Returns EntitySchema<T, U>