defineEntity

Callable

• defineEntity(meta): EntitySchema<InferEntityFromProperties<Properties>, never>

---

• Parameters

  • meta: Omit<Partial<EntityMetadata<InferEntityFromProperties<Properties>>>, properties | extends> & { name: string; properties: Properties | (properties) => Properties }

  Returns EntitySchema<InferEntityFromProperties<Properties>, never>

Index

Properties

• properties

Properties

properties

properties: { array: () => PropertyOptionsBuilder<unknown[]>; bigint: () => PropertyOptionsBuilder<NonNullable<undefined | null | string | number | bigint>>; blob: () => PropertyOptionsBuilder<NonNullable<null | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>>; boolean: () => PropertyOptionsBuilder<number>; character: () => PropertyOptionsBuilder<string>; date: () => PropertyOptionsBuilder<string>; datetime: () => PropertyOptionsBuilder<Date>; decimal: () => PropertyOptionsBuilder<NonNullable<string | number>>; double: () => PropertyOptionsBuilder<NonNullable<string | number>>; embedded: (target) => EmbeddedOptionsBuilder<InferEntity<Target extends T[] ? T : Target>>; enum: (items) => EnumOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T<T>>> : T extends Value[] ? Value : T>; enumArray: () => PropertyOptionsBuilder<(string | number)[]>; float: () => PropertyOptionsBuilder<number>; formula: (formula) => PropertyOptionsBuilder<T>; integer: () => PropertyOptionsBuilder<number>; interval: () => PropertyOptionsBuilder<string>; json: () => PropertyOptionsBuilder<T>; manyToMany: (target) => ManyToManyOptionsBuilder<Collection<InferEntity<Target>, object>>; manyToOne: (target) => ManyToOneOptionsBuilder<Reference<InferEntity<Target>>>; mediumint: () => PropertyOptionsBuilder<number>; oneToMany: (target) => OneToManyOptionsBuilderOnlyMappedBy<Collection<InferEntity<Target>, object>>; oneToOne: (target) => OneToOneOptionsBuilder<Reference<InferEntity<Target>>>; smallint: () => PropertyOptionsBuilder<number>; string: () => PropertyOptionsBuilder<string>; text: () => PropertyOptionsBuilder<string>; time: () => PropertyOptionsBuilder<any>; tinyint: () => PropertyOptionsBuilder<number>; type: (type) => PropertyOptionsBuilder<InferPropertyValueType<T>>; uint8array: () => PropertyOptionsBuilder<Uint8Array<ArrayBufferLike>>; unknown: () => PropertyOptionsBuilder<{}>; uuid: () => PropertyOptionsBuilder<string> }

Type declaration

• array: () => PropertyOptionsBuilder<unknown[]>

  • • (): PropertyOptionsBuilder<unknown[]>

    • Returns PropertyOptionsBuilder<unknown[]>

• bigint: () => PropertyOptionsBuilder<NonNullable<undefined | null | string | number | bigint>>

  • • (): PropertyOptionsBuilder<NonNullable<undefined | null | string | number | bigint>>

    • Returns PropertyOptionsBuilder<NonNullable<undefined | null | string | number | bigint>>

• blob: () => PropertyOptionsBuilder<NonNullable<null | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>>

  • • (): PropertyOptionsBuilder<NonNullable<null | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>>

    • Returns PropertyOptionsBuilder<NonNullable<null | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>>

• boolean: () => PropertyOptionsBuilder<number>

  • • (): PropertyOptionsBuilder<number>

    • Returns PropertyOptionsBuilder<number>

• character: () => PropertyOptionsBuilder<string>

  • • (): PropertyOptionsBuilder<string>

    • Returns PropertyOptionsBuilder<string>

• date: () => PropertyOptionsBuilder<string>

  • • (): PropertyOptionsBuilder<string>

    • Returns PropertyOptionsBuilder<string>

• datetime: () => PropertyOptionsBuilder<Date>

  • • (): PropertyOptionsBuilder<Date>

    • Returns PropertyOptionsBuilder<Date>

• decimal: () => PropertyOptionsBuilder<NonNullable<string | number>>

  • • (): PropertyOptionsBuilder<NonNullable<string | number>>

    • Returns PropertyOptionsBuilder<NonNullable<string | number>>

• double: () => PropertyOptionsBuilder<NonNullable<string | number>>

  • • (): PropertyOptionsBuilder<NonNullable<string | number>>

    • Returns PropertyOptionsBuilder<NonNullable<string | number>>

• embedded: (target) => EmbeddedOptionsBuilder<InferEntity<Target extends T[] ? T : Target>>

  • • (target): EmbeddedOptionsBuilder<InferEntity<Target extends T[] ? T : Target>>

    • Parameters

      • target: Target

      Returns EmbeddedOptionsBuilder<InferEntity<Target extends T[] ? T : Target>>

• enum: (items) => EnumOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T<T>>> : T extends Value[] ? Value : T>

  • • (items): EnumOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T<T>>> : T extends Value[] ? Value : T>

    • Parameters

      • optionalitems: T

      Returns EnumOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T<T>>> : T extends Value[] ? Value : T>

• enumArray: () => PropertyOptionsBuilder<(string | number)[]>

  • • (): PropertyOptionsBuilder<(string | number)[]>

    • Returns PropertyOptionsBuilder<(string | number)[]>

• float: () => PropertyOptionsBuilder<number>

  • • (): PropertyOptionsBuilder<number>

    • Returns PropertyOptionsBuilder<number>

• formula: (formula) => PropertyOptionsBuilder<T>

  • • (formula): PropertyOptionsBuilder<T>

    • Parameters

      • formula: string | (alias) => string

      Returns PropertyOptionsBuilder<T>

• integer: () => PropertyOptionsBuilder<number>

  • • (): PropertyOptionsBuilder<number>

    • Returns PropertyOptionsBuilder<number>

• interval: () => PropertyOptionsBuilder<string>

  • • (): PropertyOptionsBuilder<string>

    • Returns PropertyOptionsBuilder<string>

• json: () => PropertyOptionsBuilder<T>

  • • (): PropertyOptionsBuilder<T>

    • Returns PropertyOptionsBuilder<T>

• manyToMany: (target) => ManyToManyOptionsBuilder<Collection<InferEntity<Target>, object>>

  • • (target): ManyToManyOptionsBuilder<Collection<InferEntity<Target>, object>>

    • Parameters

      • target: Target

      Returns ManyToManyOptionsBuilder<Collection<InferEntity<Target>, object>>

• manyToOne: (target) => ManyToOneOptionsBuilder<Reference<InferEntity<Target>>>

  • • (target): ManyToOneOptionsBuilder<Reference<InferEntity<Target>>>

    • Parameters

      • target: Target

      Returns ManyToOneOptionsBuilder<Reference<InferEntity<Target>>>

• mediumint: () => PropertyOptionsBuilder<number>

  • • (): PropertyOptionsBuilder<number>

    • Returns PropertyOptionsBuilder<number>

• oneToMany: (target) => OneToManyOptionsBuilderOnlyMappedBy<Collection<InferEntity<Target>, object>>

  • • (target): OneToManyOptionsBuilderOnlyMappedBy<Collection<InferEntity<Target>, object>>

    • Parameters

      • target: Target

      Returns OneToManyOptionsBuilderOnlyMappedBy<Collection<InferEntity<Target>, object>>

• oneToOne: (target) => OneToOneOptionsBuilder<Reference<InferEntity<Target>>>

  • • (target): OneToOneOptionsBuilder<Reference<InferEntity<Target>>>

    • Parameters

      • target: Target

      Returns OneToOneOptionsBuilder<Reference<InferEntity<Target>>>

• smallint: () => PropertyOptionsBuilder<number>

  • • (): PropertyOptionsBuilder<number>

    • Returns PropertyOptionsBuilder<number>

• string: () => PropertyOptionsBuilder<string>

  • • (): PropertyOptionsBuilder<string>

    • Returns PropertyOptionsBuilder<string>

• text: () => PropertyOptionsBuilder<string>

  • • (): PropertyOptionsBuilder<string>

    • Returns PropertyOptionsBuilder<string>

• time: () => PropertyOptionsBuilder<any>

  • • (): PropertyOptionsBuilder<any>

    • Returns PropertyOptionsBuilder<any>

• tinyint: () => PropertyOptionsBuilder<number>

  • • (): PropertyOptionsBuilder<number>

    • Returns PropertyOptionsBuilder<number>

• type: (type) => PropertyOptionsBuilder<InferPropertyValueType<T>>

  • • (type): PropertyOptionsBuilder<InferPropertyValueType<T>>

    • Parameters

      • type: T

      Returns PropertyOptionsBuilder<InferPropertyValueType<T>>

• uint8array: () => PropertyOptionsBuilder<Uint8Array<ArrayBufferLike>>

  • • (): PropertyOptionsBuilder<Uint8Array<ArrayBufferLike>>

    • Returns PropertyOptionsBuilder<Uint8Array<ArrayBufferLike>>

• unknown: () => PropertyOptionsBuilder<{}>

  • • (): PropertyOptionsBuilder<{}>

    • Returns PropertyOptionsBuilder<{}>

• uuid: () => PropertyOptionsBuilder<string>

  • • (): PropertyOptionsBuilder<string>

    • Returns PropertyOptionsBuilder<string>