Skip to main content
Version: Next

@mikro-orm/core

Index

References

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

References

Raw

Renames and re-exports RawQueryFragment

Type Aliases

AnyEntity

AnyEntity<T>: Partial<T>

Type parameters

  • T = any

AnyString

AnyString: string & {}

AutoPath

AutoPath<O, P, E, D>: P extends boolean ? P : [D] extends [never] ? never : P extends any ? P extends string ? ((P & `${string}.`) extends never ? P : P & `${string}.`) extends infer Q ? Q extends `${infer A}.${infer B}` ? A extends StringKeys<O, E> ? `${A}.${AutoPath<NonNullable<GetStringKey<..., ..., ...>>, B, E, Prev[D]>}` : never : Q extends StringKeys<O, E> ? (NonNullable<...> extends unknown ? Exclude<..., ...> : never) | (StringKeys<..., ...> extends never ? never : `${...}.`) : StringKeys<O, E> | `${CollectionKeys<O>}:ref` : never : never : never

Type parameters

  • O
  • P: string | boolean
  • E: string = never
  • D: Prev[number] = 9

Cast

Cast<T, R>: T extends R ? T : R

Type parameters

  • T
  • R

CheckCallback

CheckCallback<T>: (columns) => string

Type parameters

  • T

Type declaration

    • (columns): string

    • Parameters

      • columns: Record<PropertyName<T>, string>

      Returns string

ConnectionType

ConnectionType: read | write

Constructor

Constructor<T>: new (...args) => T

Type parameters

  • T = unknown

Type declaration

    • new (...args): T

    • Parameters

      • rest...args: any[]

      Returns T

DeepPartial

DeepPartial<T>: T & { [ P in keyof T ]?: T[P] extends infer U[] ? DeepPartial<U>[] : T[P] extends Readonly<infer U>[] ? Readonly<DeepPartial<U>>[] : DeepPartial<T[P]> }

Type parameters

  • T

DefineConfig

DefineConfig<T>: T & DefineConfig.Brand

Type parameters

Dictionary

Dictionary<T>: {}

Type parameters

  • T = any

Type declaration

    EmbeddedPrefixMode

    EmbeddedPrefixMode: absolute | relative

    With absolute the prefix is set at the root of the entity (regardless of the nesting level)

    EntityClass

    EntityClass<T>: Function & { prototype: T }

    Type parameters

    • T = any

    EntityCtor

    EntityCtor<T>: abstract new (...args) => T

    Type parameters

    • T = any

    Type declaration

      • abstract new (...args): T

      • Parameters

        • rest...args: any[]

        Returns T

    EntityData

    EntityData<T, C>: { [ K in EntityKey<T> ]?: EntityDataItem<T[K] & {}, C> }

    Type parameters

    • T
    • C: boolean = false

    EntityDataValue

    EntityDataValue<T>: EntityData<T>[EntityKey<T>]

    Type parameters

    • T

    EntityDictionary

    EntityDictionary<T>: EntityData<T> & Record<any, any>

    Type parameters

    • T

    EntityDTO

    EntityDTO<T, C>: { [ K in keyof T as DTORequiredKeys<T, K> ]: EntityDTOProp<T, T[K], C> | AddOptional<T[K]> } & { [ K in keyof T as DTOOptionalKeys<T, K> ]?: EntityDTOProp<T, T[K], C> | AddOptional<T[K]> }

    Type parameters

    EntityField

    EntityField<T, P>: keyof T | PopulatePath.ALL | AutoPath<T, P, `${PopulatePath.ALL}`>

    Type parameters

    • T
    • P: string = PopulatePath.ALL

    EntityKey

    EntityKey<T, B>: string & { [ K in keyof T ]-?: CleanKeys<T, K, B> extends never ? never : K }[keyof T]

    Type parameters

    • T = unknown
    • B: boolean = false

    EntityLoaderOptions

    EntityLoaderOptions<Entity, Fields, Excludes>: { connectionType?: ConnectionType; convertCustomTypes?: boolean; exclude?: readonly EntityField<Entity, Excludes>[]; fields?: readonly EntityField<Entity, Fields>[]; filters?: FilterOptions; ignoreLazyScalarProperties?: boolean; lockMode?: Exclude<LockMode, LockMode.OPTIMISTIC>; logging?: LoggingOptions; lookup?: boolean; orderBy?: QueryOrderMap<Entity> | QueryOrderMap<Entity>[]; populateWhere?: PopulateHint | `${PopulateHint}`; refresh?: boolean; schema?: string; strategy?: LoadStrategy | `${LoadStrategy}`; validate?: boolean; where?: FilterQuery<Entity> }

    Type parameters

    • Entity
    • Fields: string = PopulatePath.ALL
    • Excludes: string = never

    Type declaration

    EntityName

    EntityName<T>: EntityClass<T> | EntityCtor<T> | EntitySchema<T, any>

    Type parameters

    • T = any

    EntityOptions

    EntityOptions<T, E>: { abstract?: boolean; collection?: string; comment?: string; constructorParams?: (T extends EntityClass<infer P> ? keyof P : string)[]; discriminatorColumn?: (T extends EntityClass<infer P> ? keyof P : string) | AnyString; discriminatorMap?: Dictionary<string>; discriminatorValue?: number | string; expression?: string | (em, where, options, stream) => object; forceConstructor?: boolean; hasTriggers?: boolean; readonly?: boolean; repository?: () => Constructor; schema?: string; tableName?: string; virtual?: boolean }

    Type parameters

    Type declaration

    • optionalabstract?: boolean

      Marks entity as abstract, such entities are inlined during discovery.

    • optionalcollection?: string

      Override default collection/table name. Alias for tableName.

    • optionalcomment?: string

      Specify comment to table. (SQL only)

    • optionalconstructorParams?: (T extends EntityClass<infer P> ? keyof P : string)[]

      Specify constructor parameters to be used in em.create or when forceConstructor is enabled. Those should be names of declared entity properties in the same order as your constructor uses them. The ORM tries to infer those automatically, use this option in case the inference fails.

    • optionaldiscriminatorColumn?: (T extends EntityClass<infer P> ? keyof P : string) | AnyString

      For Single Table Inheritance.

    • optionaldiscriminatorMap?: Dictionary<string>

      For Single Table Inheritance.

    • optionaldiscriminatorValue?: number | string

      For Single Table Inheritance.

    • optionalexpression?: string | (em, where, options, stream) => object

      SQL query that maps to a virtual entity.

    • optionalforceConstructor?: boolean

      Enforce use of constructor when creating managed entity instances.

    • optionalhasTriggers?: boolean

      Used to make ORM aware of externally defined triggers. This is needed for MS SQL Server multi inserts, ignored in other dialects.

    • optionalreadonly?: boolean

      Disables change tracking - such entities are ignored during flush.

    • optionalrepository?: () => Constructor

      Set custom repository class.

    • optionalschema?: string

      Sets the schema name.

    • optionaltableName?: string

      Override default collection/table name. Alias for collection.

    • optionalvirtual?: boolean

      Marks entity as virtual. This is set automatically when you use expression option.

    EntityProps

    EntityProps<T>: { -readonly [ K in EntityKey<T> ]?: T[K] }

    Type parameters

    • T

    EntityRef

    EntityRef<T>: true extends IsUnknown<PrimaryProperty<T>> ? Reference<T> : IsAny<T> extends true ? Reference<T> : { [ K in PrimaryProperty<T> & keyof T ]: T[K] } & Reference<T>

    Alias for Reference<T> & { id: number } (see Ref).

    Type parameters

    • T: object

    EntitySchemaMetadata

    EntitySchemaMetadata<Entity, Base, Class>: Omit<Partial<EntityMetadata<Entity>>, name | properties | extends> & ({ name: string } | { class: Class; name?: string }) & { extends?: EntityName<Base> } & { properties?: { [ Key in keyof OmitBaseProps<Entity, Base> as CleanKeys<OmitBaseProps<Entity, Base>, Key> ]-?: EntitySchemaProperty<ExpandProperty<NonNullable<Entity[Key]>>, Entity> } }

    Type parameters

    EntitySchemaProperty

    EntitySchemaProperty<Target, Owner>: ({ kind: ReferenceKind.MANY_TO_ONE | m:1 } & TypeDef<Target> & ManyToOneOptions<Owner, Target>) | ({ kind: ReferenceKind.ONE_TO_ONE | 1:1 } & TypeDef<Target> & OneToOneOptions<Owner, Target>) | ({ kind: ReferenceKind.ONE_TO_MANY | 1:m } & TypeDef<Target> & OneToManyOptions<Owner, Target>) | ({ kind: ReferenceKind.MANY_TO_MANY | m:n } & TypeDef<Target> & ManyToManyOptions<Owner, Target>) | ({ kind: ReferenceKind.EMBEDDED | embedded } & EmbeddedTypeDef<Target> & EmbeddedOptions<Owner, Target> & PropertyOptions<Owner>) | ({ enum: true } & EnumOptions<Owner>) | (TypeDef<Target> & PropertyOptions<Owner>)

    Type parameters

    • Target
    • Owner

    EntityType

    EntityType<T>: T | LoadedEntityType<T>

    Type parameters

    • T

    EntityValue

    EntityValue<T>: T[EntityKey<T>]

    Type parameters

    • T

    ExpandHint

    ExpandHint<T, L>: L | AddEager<T>

    Type parameters

    • T
    • L: string

    ExpandProperty

    ExpandProperty<T>: T extends Reference<infer U> ? NonNullable<U> : T extends Collection<infer U, any> ? NonNullable<U> : T extends infer U[] ? NonNullable<U> : NonNullable<T>

    Type parameters

    • T

    ExpandQuery

    ExpandQuery<T>: T extends object ? T extends Scalar ? never : FilterQuery<T> : FilterValue<T>

    Type parameters

    • T

    ExpandScalar

    ExpandScalar<T>: null | (T extends string ? T | RegExp : T extends Date ? Date | string : T extends bigint ? bigint | string | number : T)

    Type parameters

    • T

    FilterDef

    FilterDef<T>: FilterDefResolved<EntityFromInput<T>> & { entity?: T }

    Type parameters

    FilterItemValue

    FilterItemValue<T>: T | ExpandScalar<T> | Primary<T>

    Type parameters

    • T

    FilterKey

    FilterKey<T>: keyof FilterQuery<T>

    Type parameters

    • T

    FilterObject

    FilterObject<T>: { -readonly [ K in EntityKey<T> ]?: ExpandQuery<ExpandProperty<T[K]>> | FilterValue<ExpandProperty<T[K]>> | null }

    Type parameters

    • T

    FilterOptions

    FilterOptions: Dictionary<boolean | Dictionary> | string[] | boolean

    FilterQuery

    FilterQuery<T>: ObjectQuery<T> | NonNullable<ExpandScalar<Primary<T>>> | NonNullable<EntityProps<T> & OperatorMap<T>> | FilterQuery<T>[]

    Type parameters

    • T

    FilterValue

    FilterValue<T>: OperatorMap<FilterItemValue<T>> | FilterItemValue<T> | FilterItemValue<T>[] | null

    Type parameters

    • T

    FormulaCallback

    FormulaCallback<T>: (table, columns) => string

    Type parameters

    • T

    Type declaration

      • (table, columns): string

      • Parameters

        Returns string

    FormulaTable

    FormulaTable: { alias: string; name: string; qualifiedName: string; schema?: string; toString: () => string }

    Type declaration

    • alias: string
    • name: string
    • qualifiedName: string
    • optionalschema?: string
    • toString: () => string
        • (): string

        • Returns string

    FromEntityType

    FromEntityType<T>: T extends LoadedEntityType<infer U> ? U : T

    Type parameters

    • T

    GeneratedColumnCallback

    GeneratedColumnCallback<T>: (columns) => string

    Type parameters

    • T

    Type declaration

      • (columns): string

      • Parameters

        • columns: Record<keyof T, string>

        Returns string

    GetRepository

    GetRepository<Entity, Fallback>: Entity[typeof EntityRepositoryType] extends EntityRepository<any> | undefined ? NonNullable<Entity[typeof EntityRepositoryType]> : Fallback

    Type parameters

    • Entity: {}
    • Fallback

    Hidden

    Hidden<T>: T & Hidden.Brand

    Type parameters

    • T = unknown

    ImportsResolver

    ImportsResolver: (alias, basePath, extension, originFileName) => { name: string; path: string } | undefined

    Type declaration

      • (alias, basePath, extension, originFileName): { name: string; path: string } | undefined

      • Parameters

        • alias: string
        • basePath: string
        • extension: .js |
        • originFileName: string

        Returns { name: string; path: string } | undefined

    IndexCallback

    IndexCallback<T>: (table, columns, indexName) => string | Raw

    Type parameters

    • T

    Type declaration

      • (table, columns, indexName): string | Raw

      • Parameters

        • table: TableName
        • columns: Record<PropertyName<T>, string>
        • indexName: string

        Returns string | Raw

    InferEntity

    InferEntity<Schema>: Schema extends { ~entity: infer E } ? E : Schema extends EntitySchema<infer Entity> ? Entity : Schema extends EntityClass<infer Entity> ? Entity : Schema

    Type parameters

    • Schema

    InferEntityFromProperties

    InferEntityFromProperties<Properties, PK, Base>: { -readonly [ K in keyof Properties ]: InferBuilderValue<MaybeReturnType<Properties[K]>> } & { [PrimaryKeyProp]?: InferCombinedPrimaryKey<Properties, PK, Base> } & (IsNever<Base> extends true ? {} : Omit<Base, typeof PrimaryKeyProp>)

    Type parameters

    • Properties: Record<string, any>
    • PK: keyof Properties[] | undefined = undefined
    • Base = never

    InferPrimaryKey

    InferPrimaryKey<Properties>: { [ K in keyof Properties ]: MaybeReturnType<Properties[K]> extends { ~options: { primary: true } } ? K : never }[keyof Properties]

    Type parameters

    • Properties: Record<string, any>

    IPrimaryKey

    IPrimaryKey<T>: T

    Type parameters

    • T: IPrimaryKeyValue = IPrimaryKeyValue

    IsSubset

    IsSubset<T, U>: keyof U extends keyof T ? {} : Dictionary extends U ? {} : { [ K in keyof U as K extends keyof T ? never : CleanKeys<U, K> ]: never }

    Type parameters

    • T
    • U

    IsUnknown

    IsUnknown<T>: T extends unknown ? unknown extends T ? true : never : never

    Type parameters

    • T

    IType

    IType<Runtime, Raw, Serialized>: Runtime & { __raw?: Raw; __runtime?: Runtime; __serialized?: Serialized }

    Type parameters

    • Runtime
    • Raw
    • Serialized = Raw

    Loaded

    Loaded<T, L, F, E>: LoadedInternal<T, L, F, E> & { [___loadedType]?: T }

    Represents entity with its loaded relations (populate hint) and selected properties (fields hint).

    Type parameters

    • T
    • L: string = never
    • F: string = *
    • E: string = never

    LoggerNamespace

    LoggerNamespace: query | query-params | schema | discovery | info | deprecated

    LoggingOptions

    LoggingOptions: Pick<LogContext, label | enabled | debugMode>

    Logger options to modify format output and overrides, including a label and additional properties that can be accessed by custom loggers.

    Differs from LoggerOptions in terms of how they are used; this type is primarily a public type meant to be used within methods like em.find().

    @example
    await em.findOne(User, 1, { logger: { label: 'user middleware' } };
    // [query] (user middleware) select * from user where id = 1;

    MaybePromise

    MaybePromise<T>: T | Promise<T>

    Type parameters

    • T

    MergeLoaded

    MergeLoaded<T, U, P, F, E, R>: T extends Loaded<U, infer PP, infer FF, infer EE> ? string extends FF ? Loaded<T, P, F, AnyStringToNever<EE> | E> : string extends P ? Loaded<U, never, F | (FF & string), MergeExcludes<F | (FF & string), EE | E>> : Loaded<U, P | AnyStringToNever<PP>, MergeFields<F, AnyStringToNever<FF>, P, PP>, MergeExcludes<MergeFields<F, AnyStringToNever<FF>, P, PP>, (R extends true ? never : EE) | E>> : Loaded<T, P, F>

    Type parameters

    • T
    • U
    • P: string
    • F: string
    • E: string
    • R: boolean = false

    MergeSelected

    MergeSelected<T, U, F>: T extends Loaded<infer TT, infer P, infer FF, infer E> ? IsNever<Exclude<E, F>> extends true ? Loaded<TT, P, AnyStringToNever<F> | AnyStringToNever<FF>> : Loaded<TT, AnyStringToNever<P>, AnyStringToNever<FF>, AnyStringToNever<Exclude<E, F>>> : T

    Type parameters

    • T
    • U
    • F: string

    MetadataProcessor

    MetadataProcessor: (metadata, platform) => MaybePromise<void>

    Type declaration

    MigrateOptions

    MigrateOptions: { from?: string | number; migrations?: string[]; to?: string | number; transaction?: Transaction }

    Type declaration

    • optionalfrom?: string | number
    • optionalmigrations?: string[]
    • optionalto?: string | number
    • optionaltransaction?: Transaction

    MigrationResult

    MigrationResult: { code: string; diff: MigrationDiff; fileName: string }

    Type declaration

    MigrationRow

    MigrationRow: { executed_at: Date; id: number; name: string }

    Type declaration

    • executed_at: Date
    • id: number
    • name: string

    MigrationsOptions

    MigrationsOptions: { allOrNothing?: boolean; disableForeignKeys?: boolean; dropTables?: boolean; emit?: js | ts | cjs; fileName?: (timestamp, name) => string; generator?: Constructor<IMigrationGenerator>; glob?: string; migrationsList?: (MigrationObject | Constructor<Migration>)[]; path?: string; pathTs?: string; safe?: boolean; silent?: boolean; snapshot?: boolean; snapshotName?: string; tableName?: string; transactional?: boolean }

    Configuration options for database migrations.

    @see

    https://mikro-orm.io/docs/migrations

    Type declaration

    • optionalallOrNothing?: boolean

      Run all migrations in the current batch in a master transaction.

    • optionaldisableForeignKeys?: boolean

      Try to disable foreign key checks during migrations.

    • optionaldropTables?: boolean

      Allow dropping tables during schema diff.

    • optionalemit?: js | ts | cjs

      File extension for generated migration files.

    • optionalfileName?: (timestamp, name) => string

      Custom function to generate migration file names.

        • (timestamp, name): string

        • Parameters

          • timestamp: string
          • optionalname: string

          Returns string

    • optionalgenerator?: Constructor<IMigrationGenerator>

      Custom migration generator class.

    • optionalglob?: string

      Glob pattern to match migration files.

    • optionalmigrationsList?: (MigrationObject | Constructor<Migration>)[]

      List of migration classes or objects to use instead of file-based discovery.

    • optionalpath?: string

      Path to the folder with migration files (for compiled JavaScript files).

    • optionalpathTs?: string

      Path to the folder with migration files (for TypeScript source files). Used when running in TypeScript mode.

    • optionalsafe?: boolean

      Safe mode - only allow adding new tables and columns, never dropping existing ones.

    • optionalsilent?: boolean

      Disable logging for migration operations.

    • optionalsnapshot?: boolean

      Create a snapshot of the current schema after migration generation.

    • optionalsnapshotName?: string

      Custom name for the snapshot file.

    • optionaltableName?: string

      Name of the migrations table.

    • optionaltransactional?: boolean

      Run each migration inside a transaction.

    MigratorEvent

    MigratorEvent: migrating | migrated | reverting | reverted

    New

    New<T, P>: Loaded<T, P>

    Type parameters

    • T
    • P: string = string

    NoInfer

    NoInfer<T>: [T][T extends any ? 0 : never]

    Type parameters

    • T

    ObjectQuery

    ObjectQuery<T>: OperatorMap<T> & FilterObject<T>

    Type parameters

    • T

    Opt

    Opt<T>: T & Opt.Brand

    Type parameters

    • T = unknown

    OrderDefinition

    OrderDefinition<T>: (QueryOrderMap<T> & { 0?: never }) | QueryOrderMap<T>[]

    Type parameters

    • T

    Populate

    Populate<T, P>: readonly AutoPath<T, P, `${PopulatePath}`>[] | false

    Type parameters

    • T
    • P: string = never

    PopulateOptions

    PopulateOptions<T>: { all?: boolean; children?: PopulateOptions<T[keyof T]>[]; dataOnly?: boolean; field: EntityKey<T>; filter?: boolean; joinType?: inner join | left join; strategy?: LoadStrategy }

    Type parameters

    • T

    Type declaration

    • optionalall?: boolean
    • optionalchildren?: PopulateOptions<T[keyof T]>[]
    • optionaldataOnly?: boolean

      When true, ignores mapToPk on the property and returns full entity data instead of just PKs.

    • field: EntityKey<T>
    • optionalfilter?: boolean
    • optionaljoinType?: inner join | left join
    • optionalstrategy?: LoadStrategy

    Primary

    Primary<T>: IsAny<T> extends true ? any : T extends { [PrimaryKeyProp]?: infer PK } ? PK extends undefined ? Omit<T, typeof PrimaryKeyProp> : PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends keyof T[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends { _id?: infer PK } ? ReadonlyPrimary<PK> | string : T extends { id?: infer PK } ? ReadonlyPrimary<PK> : T extends { uuid?: infer PK } ? ReadonlyPrimary<PK> : T

    Type parameters

    • T

    QBFilterQuery

    QBFilterQuery<T>: ObjectQuery<T> | Dictionary

    Type parameters

    • T = any

    QBQueryOrderMap

    QBQueryOrderMap<T>: QueryOrderMap<T> | Dictionary

    Type parameters

    • T

    QueryOrderKeys

    QueryOrderKeys<T>: QueryOrderKeysFlat | QueryOrderMap<T>

    Type parameters

    • T

    QueryOrderKeysFlat

    QueryOrderKeysFlat: QueryOrder | QueryOrderNumeric | `${QueryOrder}`

    QueryOrderMap

    QueryOrderMap<T>: { [ K in EntityKey<T> ]?: QueryOrderKeys<ExpandProperty<T[K]>> }

    Type parameters

    • T

    RawQueryFragmentSymbol

    RawQueryFragmentSymbol: symbol & { [rawFragmentSymbolBrand]: true }

    Ref

    Ref<T>: T extends any ? IsAny<T> extends true ? Reference<T & object> : T extends Scalar ? ScalarReference<T> : EntityRef<T & object> : never

    Ref type represents a Reference instance, and adds the primary keys to its prototype automatically, so you can do ref.id instead of ref.unwrap().id. It resolves to either ScalarRef or EntityRef, based on the type argument.

    Type parameters

    • T

    Rel

    Rel<T>: T

    Identity type that can be used to get around issues with cycles in bidirectional relations. It will disable reflect-metadata inference.

    Type parameters

    • T

    RequiredEntityData

    RequiredEntityData<T, I, C>: { [ K in keyof T as RequiredKeys<T, K, I> ]: T[K] | RequiredEntityDataProp<T[K], T, C> | Primary<T[K]> } & { [ K in keyof T as OptionalKeys<T, K, I> ]?: T[K] | RequiredEntityDataProp<T[K], T, C> | Primary<T[K]> | null }

    Type parameters

    • T
    • I = never
    • C: boolean = false

    RequiredNullable

    RequiredNullable<T>: (T & RequiredNullable.Brand) | null

    Type parameters

    • T = never

    RequiredOptions

    RequiredOptions<D, EM, Entities>: MarkRequired<Options<D, EM, Entities>, typeof DEFAULTS>

    Type parameters

    Scalar

    Scalar: boolean | number | string | bigint | symbol | Date | RegExp | Uint8Array | { toHexString: any }

    ScalarRef

    ScalarRef<T>: ScalarReference<T>

    Alias for ScalarReference (see Ref).

    Type parameters

    • T

    Selected

    Selected<T, L, F>: { [ K in keyof T as IsPrefixed<T, K, L | F | AddEager<T>> ]: LoadedProp<NonNullable<T[K]>, Suffix<K, L, true>, Suffix<K, F, true>> | AddOptional<T[K]> } & { [ K in keyof T as FunctionKeys<T, K> ]: T[K] } & { [___selectedType]?: T }

    Type parameters

    • T
    • L: string = never
    • F: string = *

    Transaction

    Transaction<T>: T & {}

    Type parameters

    • T = any

    TransactionEventType

    TransactionEventType: EventType.beforeTransactionStart | EventType.afterTransactionStart | EventType.beforeTransactionCommit | EventType.afterTransactionCommit | EventType.beforeTransactionRollback | EventType.afterTransactionRollback

    UmzugMigration

    UmzugMigration: { name: string; path?: string }

    Type declaration

    • name: string
    • optionalpath?: string

    UnboxArray

    UnboxArray<T>: T extends any[] ? ArrayElement<T> : T

    Type parameters

    • T

    UniversalPropertyKeys

    UniversalPropertyKeys: keyof PropertyOptions<any> | keyof EnumOptions<any> | keyof EmbeddedOptions<any, any> | keyof ReferenceOptions<any, any> | keyof ManyToOneOptions<any, any> | keyof OneToManyOptions<any, any> | keyof OneToOneOptions<any, any> | keyof ManyToManyOptions<any, any>

    Variables

    constARRAY_OPERATORS

    ARRAY_OPERATORS: string[] = ...

    constConfig

    Config: typeof Config = ...

    constEagerProps

    EagerProps: typeof EagerProps = ...

    constEntityManagerType

    EntityManagerType: typeof EntityManagerType = ...

    constEntityRepositoryType

    EntityRepositoryType: typeof EntityRepositoryType = ...

    constEventTypeMap

    EventTypeMap: Record<EventType, number> = ...

    constHiddenProps

    HiddenProps: typeof HiddenProps = ...

    constJSON_KEY_OPERATORS

    JSON_KEY_OPERATORS: string[] = ...

    constJsonProperty

    JsonProperty: typeof JsonProperty = ...

    constOptionalProps

    OptionalProps: typeof OptionalProps = ...

    constp

    p: { 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>
        • 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>

        constPrimaryKeyProp

        PrimaryKeyProp: typeof PrimaryKeyProp = ...

        constSCALAR_TYPES

        SCALAR_TYPES: Set<string> = ...

        constt

        t: { array: typeof ArrayType; bigint: typeof BigIntType; blob: typeof BlobType; boolean: typeof BooleanType; character: typeof CharacterType; date: typeof DateType; datetime: typeof DateTimeType; decimal: typeof DecimalType; double: typeof DoubleType; enum: typeof EnumType; enumArray: typeof EnumArrayType; float: typeof FloatType; integer: typeof IntegerType; interval: typeof IntervalType; json: typeof JsonType; mediumint: typeof MediumIntType; smallint: typeof SmallIntType; string: typeof StringType; text: typeof TextType; time: typeof TimeType; tinyint: typeof TinyIntType; uint8array: typeof Uint8ArrayType; unknown: typeof UnknownType; uuid: typeof UuidType } = types

        Type declaration

        consttypes

        types: { array: typeof ArrayType; bigint: typeof BigIntType; blob: typeof BlobType; boolean: typeof BooleanType; character: typeof CharacterType; date: typeof DateType; datetime: typeof DateTimeType; decimal: typeof DecimalType; double: typeof DoubleType; enum: typeof EnumType; enumArray: typeof EnumArrayType; float: typeof FloatType; integer: typeof IntegerType; interval: typeof IntervalType; json: typeof JsonType; mediumint: typeof MediumIntType; smallint: typeof SmallIntType; string: typeof StringType; text: typeof TextType; time: typeof TimeType; tinyint: typeof TinyIntType; uint8array: typeof Uint8ArrayType; unknown: typeof UnknownType; uuid: typeof UuidType } = ...

        Type declaration

        Page Options