EntitySchema <T, U>

Index

Constructors

• constructor

Accessors

• meta
• name

Methods

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

Constructors

constructor

• new EntitySchema<T, U>(meta: EntitySchemaMetadata<T, U>): EntitySchema<T, U>

• Type parameters

  • T = any
  • U = never

  Parameters

  • meta: EntitySchemaMetadata<T, U>

  Returns EntitySchema<T, U>

Accessors

meta

• get meta(): EntityMetadata<T>

• Returns EntityMetadata<T>

name

• get name(): EntityName<T>

• Returns EntityName<T>

Methods

addEmbedded

• addEmbedded<K>(name: string & keyof T, options: EmbeddedOptions): void

• Type parameters

  • K = Partial<any>

  Parameters

  • name: string & keyof T

  • options: EmbeddedOptions

  Returns void

addEnum

• addEnum(name: string & keyof T, type?: TypeType, options?: EnumOptions<T>): void

• Parameters

  • name: string & keyof T

  • optionaltype: TypeType

  • options: EnumOptions<T> = {}

  Returns void

addIndex

• addIndex<T>(options: Required<Omit<IndexOptions<T>, type | name | expression | options>> & { expression?: string; name?: string; options?: Dictionary }): void

• Type parameters

  • T

  Parameters

  • options: Required<Omit<IndexOptions<T>, type | name | expression | options>> & { expression?: string; name?: string; options?: Dictionary }

  Returns void

addManyToMany

• addManyToMany<K>(name: string & keyof T, type: TypeType, options: ManyToManyOptions<K, T>): void

• Type parameters

  • K = Partial<any>

  Parameters

  • name: string & keyof T

  • type: TypeType

  • options: ManyToManyOptions<K, T>

  Returns void

addManyToOne

• addManyToOne<K>(name: string & keyof T, type: TypeType, options: ManyToOneOptions<K, T>): void

• Type parameters

  • K = Partial<any>

  Parameters

  • name: string & keyof T

  • type: TypeType

  • options: ManyToOneOptions<K, T>

  Returns void

addOneToMany

• addOneToMany<K>(name: string & keyof T, type: TypeType, options: OneToManyOptions<K, T>): void

• Type parameters

  • K = Partial<any>

  Parameters

  • name: string & keyof T

  • type: TypeType

  • options: OneToManyOptions<K, T>

  Returns void

addOneToOne

• addOneToOne<K>(name: string & keyof T, type: TypeType, options: OneToOneOptions<K, T>): void

• Type parameters

  • K = Partial<any>

  Parameters

  • name: string & keyof T

  • type: TypeType

  • options: OneToOneOptions<K, T>

  Returns void

addPrimaryKey

• addPrimaryKey(name: string & keyof T, type: TypeType, options?: PrimaryKeyOptions<T>): void

• Parameters

  • name: string & keyof T

  • type: TypeType

  • options: PrimaryKeyOptions<T> = {}

  Returns void

addProperty

• addProperty(name: string & keyof T, type?: TypeType, options?: EntityProperty<any> | PropertyOptions<T>): void

• Parameters

  • name: string & keyof T

  • optionaltype: TypeType

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

  Returns void

addSerializedPrimaryKey

• addSerializedPrimaryKey(name: string & keyof T, type: TypeType, options?: SerializedPrimaryKeyOptions<T>): void

• Parameters

  • name: string & keyof T

  • type: TypeType

  • options: SerializedPrimaryKeyOptions<T> = {}

  Returns void

addUnique

• addUnique<T>(options: Required<Omit<UniqueOptions<T>, name | expression | options>> & { name?: string; options?: Dictionary }): void

• Type parameters

  • T

  Parameters

  • options: Required<Omit<UniqueOptions<T>, name | expression | options>> & { name?: string; options?: Dictionary }

  Returns void

addVersion

• addVersion(name: string & keyof T, type: TypeType, options?: PropertyOptions<T>): void

• Parameters

  • name: string & keyof T

  • type: TypeType

  • options: PropertyOptions<T> = {}

  Returns void

setClass

• setClass(proto: Constructor<T>): void

• Parameters

  • proto: Constructor<T>

  Returns void

setCustomRepository

• setCustomRepository(repository: () => Constructor<EntityRepository<any>>): void

• Parameters

  • repository: () => Constructor<EntityRepository<any>>

  Returns void

setExtends

• setExtends(base: string): void

• Parameters

  • base: string

  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>