defineEntity

Callable

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

Type declaration

• array: <T>(toJsValue, toDbValue) => PropertyOptionsBuilder<T[]>

  • • <T>(toJsValue, toDbValue): PropertyOptionsBuilder<T[]>

    • Parameters

      • toJsValue: (i) => T = ...

      • toDbValue: (i) => string = ...

      Returns PropertyOptionsBuilder<T[]>

• bigint: <Mode>(mode) => PropertyOptionsBuilder<JSTypeByMode<Mode> & {}>

  • • <Mode>(mode): PropertyOptionsBuilder<JSTypeByMode<Mode> & {}>

    • Parameters

      • optionalmode: Mode

      Returns PropertyOptionsBuilder<JSTypeByMode<Mode> & {}>

• 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<NonNullable<undefined | null | boolean>>

  • • (): PropertyOptionsBuilder<NonNullable<undefined | null | boolean>>

    • Returns PropertyOptionsBuilder<NonNullable<undefined | null | boolean>>

• 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: <Mode>(mode) => PropertyOptionsBuilder<NonNullable<JSTypeByMode<Mode>>>

  • • <Mode>(mode): PropertyOptionsBuilder<NonNullable<JSTypeByMode<Mode>>>

    • Parameters

      • optionalmode: Mode

      Returns PropertyOptionsBuilder<NonNullable<JSTypeByMode<Mode>>>

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

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

    • Returns PropertyOptionsBuilder<NonNullable<string | number>>

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

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

    • Parameters

      • target: Target

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

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

  • • <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: <T>(formula) => PropertyOptionsBuilder<T>

  • • <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: <T>() => PropertyOptionsBuilder<T>

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

    • Returns PropertyOptionsBuilder<T>

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

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

    • Parameters

      • target: Target

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

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

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

    • Parameters

      • target: Target

      Returns ManyToOneOptionsBuilder<Reference<InferEntity<Target>>>

• mediumint: () => PropertyOptionsBuilder<number>

  • • (): PropertyOptionsBuilder<number>

    • Returns PropertyOptionsBuilder<number>

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

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

    • Parameters

      • target: Target

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

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

  • • <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: <T>(type) => PropertyOptionsBuilder<InferPropertyValueType<T>>

  • • <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>