Skip to main content
Version: Next

defineEntity

Callable


Index

Properties

Properties

properties

properties: { array: <T>(toJsValue, toDbValue) => UniversalPropertyOptionsBuilder<T[], EmptyOptions, IncludeKeysForProperty>; bigint: <Mode>(mode) => UniversalPropertyOptionsBuilder<JSTypeByMode<Mode> & {}, EmptyOptions, IncludeKeysForProperty>; blob: () => UniversalPropertyOptionsBuilder<NonNullable<null | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>, EmptyOptions, IncludeKeysForProperty>; boolean: () => UniversalPropertyOptionsBuilder<NonNullable<undefined | null | boolean>, EmptyOptions, IncludeKeysForProperty>; character: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>; date: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>; datetime: (length) => UniversalPropertyOptionsBuilder<Date, EmptyOptions, IncludeKeysForProperty>; decimal: <Mode>(mode) => UniversalPropertyOptionsBuilder<NonNullable<JSTypeByMode<Mode>>, EmptyOptions, IncludeKeysForProperty>; double: () => UniversalPropertyOptionsBuilder<NonNullable<string | number>, EmptyOptions, IncludeKeysForProperty>; embedded: <Target>(target) => UniversalPropertyOptionsBuilder<InferEntity<Target extends T[] ? T : Target>, EmptyOptions, IncludeKeysForEmbeddedOptions>; enum: <T>(items) => UniversalPropertyOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T<T>>> : T extends Value[] ? Value : T, EmptyOptions, IncludeKeysForEnumOptions>; enumArray: () => UniversalPropertyOptionsBuilder<(string | number)[], EmptyOptions, IncludeKeysForProperty>; float: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>; formula: <T>(formula) => UniversalPropertyOptionsBuilder<T, EmptyOptions, IncludeKeysForProperty>; integer: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>; interval: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>; json: <T>() => UniversalPropertyOptionsBuilder<T, EmptyOptions, IncludeKeysForProperty>; manyToMany: <Target>(target) => UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: m:n }, IncludeKeysForManyToManyOptions>; manyToOne: <Target>(target) => UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: m:1 }, IncludeKeysForManyToOneOptions>; mediumint: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>; oneToMany: <Target>(target) => OneToManyOptionsBuilderOnlyMappedBy<InferEntity<Target>>; oneToOne: <Target>(target) => UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: 1:1 }, IncludeKeysForOneToOneOptions>; smallint: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>; string: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>; text: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>; time: (length) => UniversalPropertyOptionsBuilder<any, EmptyOptions, IncludeKeysForProperty>; tinyint: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>; type: <T>(type) => UniversalPropertyOptionsBuilder<InferPropertyValueType<T>, EmptyOptions, IncludeKeysForProperty>; uint8array: () => UniversalPropertyOptionsBuilder<Uint8Array<ArrayBufferLike>, EmptyOptions, IncludeKeysForProperty>; unknown: () => UniversalPropertyOptionsBuilder<{}, EmptyOptions, IncludeKeysForProperty>; uuid: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty> }

Type declaration

  • array: <T>(toJsValue, toDbValue) => UniversalPropertyOptionsBuilder<T[], EmptyOptions, IncludeKeysForProperty>
      • <T>(toJsValue, toDbValue): UniversalPropertyOptionsBuilder<T[], EmptyOptions, IncludeKeysForProperty>
      • Parameters

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

            Returns UniversalPropertyOptionsBuilder<T[], EmptyOptions, IncludeKeysForProperty>

      • bigint: <Mode>(mode) => UniversalPropertyOptionsBuilder<JSTypeByMode<Mode> & {}, EmptyOptions, IncludeKeysForProperty>
          • <Mode>(mode): UniversalPropertyOptionsBuilder<JSTypeByMode<Mode> & {}, EmptyOptions, IncludeKeysForProperty>
          • Parameters

            • optionalmode: Mode

            Returns UniversalPropertyOptionsBuilder<JSTypeByMode<Mode> & {}, EmptyOptions, IncludeKeysForProperty>

      • blob: () => UniversalPropertyOptionsBuilder<NonNullable<null | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>, EmptyOptions, IncludeKeysForProperty>
          • (): UniversalPropertyOptionsBuilder<NonNullable<null | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>, EmptyOptions, IncludeKeysForProperty>
          • Returns UniversalPropertyOptionsBuilder<NonNullable<null | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>, EmptyOptions, IncludeKeysForProperty>

      • boolean: () => UniversalPropertyOptionsBuilder<NonNullable<undefined | null | boolean>, EmptyOptions, IncludeKeysForProperty>
          • (): UniversalPropertyOptionsBuilder<NonNullable<undefined | null | boolean>, EmptyOptions, IncludeKeysForProperty>
          • Returns UniversalPropertyOptionsBuilder<NonNullable<undefined | null | boolean>, EmptyOptions, IncludeKeysForProperty>

      • character: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
          • (): UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
          • Returns UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>

      • date: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
          • (): UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
          • Returns UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>

      • datetime: (length) => UniversalPropertyOptionsBuilder<Date, EmptyOptions, IncludeKeysForProperty>
          • (length): UniversalPropertyOptionsBuilder<Date, EmptyOptions, IncludeKeysForProperty>
          • Parameters

            • optionallength: number

            Returns UniversalPropertyOptionsBuilder<Date, EmptyOptions, IncludeKeysForProperty>

      • decimal: <Mode>(mode) => UniversalPropertyOptionsBuilder<NonNullable<JSTypeByMode<Mode>>, EmptyOptions, IncludeKeysForProperty>
          • <Mode>(mode): UniversalPropertyOptionsBuilder<NonNullable<JSTypeByMode<Mode>>, EmptyOptions, IncludeKeysForProperty>
          • Parameters

            • optionalmode: Mode

            Returns UniversalPropertyOptionsBuilder<NonNullable<JSTypeByMode<Mode>>, EmptyOptions, IncludeKeysForProperty>

      • double: () => UniversalPropertyOptionsBuilder<NonNullable<string | number>, EmptyOptions, IncludeKeysForProperty>
          • (): UniversalPropertyOptionsBuilder<NonNullable<string | number>, EmptyOptions, IncludeKeysForProperty>
          • Returns UniversalPropertyOptionsBuilder<NonNullable<string | number>, EmptyOptions, IncludeKeysForProperty>

      • embedded: <Target>(target) => UniversalPropertyOptionsBuilder<InferEntity<Target extends T[] ? T : Target>, EmptyOptions, IncludeKeysForEmbeddedOptions>
          • <Target>(target): UniversalPropertyOptionsBuilder<InferEntity<Target extends T[] ? T : Target>, EmptyOptions, IncludeKeysForEmbeddedOptions>
          • Parameters

            • target: Target

            Returns UniversalPropertyOptionsBuilder<InferEntity<Target extends T[] ? T : Target>, EmptyOptions, IncludeKeysForEmbeddedOptions>

      • enum: <T>(items) => UniversalPropertyOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T<T>>> : T extends Value[] ? Value : T, EmptyOptions, IncludeKeysForEnumOptions>
          • <T>(items): UniversalPropertyOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T<T>>> : T extends Value[] ? Value : T, EmptyOptions, IncludeKeysForEnumOptions>
          • Parameters

            • optionalitems: T

            Returns UniversalPropertyOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T<T>>> : T extends Value[] ? Value : T, EmptyOptions, IncludeKeysForEnumOptions>

      • enumArray: () => UniversalPropertyOptionsBuilder<(string | number)[], EmptyOptions, IncludeKeysForProperty>
          • (): UniversalPropertyOptionsBuilder<(string | number)[], EmptyOptions, IncludeKeysForProperty>
          • Returns UniversalPropertyOptionsBuilder<(string | number)[], EmptyOptions, IncludeKeysForProperty>

      • float: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
          • (): UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
          • Returns UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>

      • formula: <T>(formula) => UniversalPropertyOptionsBuilder<T, EmptyOptions, IncludeKeysForProperty>
          • <T>(formula): UniversalPropertyOptionsBuilder<T, EmptyOptions, IncludeKeysForProperty>
          • Parameters

            • formula: string | (alias) => string

              Returns UniversalPropertyOptionsBuilder<T, EmptyOptions, IncludeKeysForProperty>

        • integer: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>

        • interval: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>

        • json: <T>() => UniversalPropertyOptionsBuilder<T, EmptyOptions, IncludeKeysForProperty>
            • <T>(): UniversalPropertyOptionsBuilder<T, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<T, EmptyOptions, IncludeKeysForProperty>

        • manyToMany: <Target>(target) => UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: m:n }, IncludeKeysForManyToManyOptions>
            • <Target>(target): UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: m:n }, IncludeKeysForManyToManyOptions>
            • Parameters

              • target: Target

              Returns UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: m:n }, IncludeKeysForManyToManyOptions>

        • manyToOne: <Target>(target) => UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: m:1 }, IncludeKeysForManyToOneOptions>
            • <Target>(target): UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: m:1 }, IncludeKeysForManyToOneOptions>
            • Parameters

              • target: Target

              Returns UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: m:1 }, IncludeKeysForManyToOneOptions>

        • mediumint: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>

        • oneToMany: <Target>(target) => OneToManyOptionsBuilderOnlyMappedBy<InferEntity<Target>>
            • <Target>(target): OneToManyOptionsBuilderOnlyMappedBy<InferEntity<Target>>
            • Parameters

              • target: Target

              Returns OneToManyOptionsBuilderOnlyMappedBy<InferEntity<Target>>

        • oneToOne: <Target>(target) => UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: 1:1 }, IncludeKeysForOneToOneOptions>
            • <Target>(target): UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: 1:1 }, IncludeKeysForOneToOneOptions>
            • Parameters

              • target: Target

              Returns UniversalPropertyOptionsBuilder<InferEntity<Target>, EmptyOptions & { kind: 1:1 }, IncludeKeysForOneToOneOptions>

        • smallint: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>

        • string: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>

        • text: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>

        • time: (length) => UniversalPropertyOptionsBuilder<any, EmptyOptions, IncludeKeysForProperty>
            • (length): UniversalPropertyOptionsBuilder<any, EmptyOptions, IncludeKeysForProperty>
            • Parameters

              • optionallength: number

              Returns UniversalPropertyOptionsBuilder<any, EmptyOptions, IncludeKeysForProperty>

        • tinyint: () => UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<number, EmptyOptions, IncludeKeysForProperty>

        • type: <T>(type) => UniversalPropertyOptionsBuilder<InferPropertyValueType<T>, EmptyOptions, IncludeKeysForProperty>
            • <T>(type): UniversalPropertyOptionsBuilder<InferPropertyValueType<T>, EmptyOptions, IncludeKeysForProperty>
            • Parameters

              • type: T

              Returns UniversalPropertyOptionsBuilder<InferPropertyValueType<T>, EmptyOptions, IncludeKeysForProperty>

        • uint8array: () => UniversalPropertyOptionsBuilder<Uint8Array<ArrayBufferLike>, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<Uint8Array<ArrayBufferLike>, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<Uint8Array<ArrayBufferLike>, EmptyOptions, IncludeKeysForProperty>

        • unknown: () => UniversalPropertyOptionsBuilder<{}, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<{}, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<{}, EmptyOptions, IncludeKeysForProperty>

        • uuid: () => UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
            • (): UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>
            • Returns UniversalPropertyOptionsBuilder<string, EmptyOptions, IncludeKeysForProperty>

        Page Options