PropertyChain <Value, Options>

Lightweight chain result type for property builders - reduces type instantiation cost by avoiding full class resolution.

Index

Properties

• ~options
• ~type

Methods

• $type
• accessor
• array
• autoincrement
• cascade
• check
• columnType
• columnTypes
• comment
• concurrencyCheck
• createForeignKeyConstraint
• customOrder
• default
• defaultRaw
• deferMode
• deleteRule
• discriminator
• discriminatorMap
• eager
• extra
• fieldName
• fieldNames
• filters
• fixedOrder
• fixedOrderColumn
• foreignKeyName
• formula
• generated
• getter
• getterName
• groups
• hidden
• hydrate
• ignoreSchemaChanges
• index
• inversedBy
• inverseJoinColumn
• inverseJoinColumns
• joinColumn
• joinColumns
• lazy
• length
• mappedBy
• mapToPk
• name
• nativeEnumName
• nullable
• object
• onCreate
• onUpdate
• orderBy
• orphanRemoval
• ownColumns
• owner
• persist
• pivotEntity
• pivotTable
• precision
• prefix
• prefixMode
• primary
• ref
• referenceColumnName
• referencedColumnNames
• returning
• runtimeType
• scale
• serializedName
• serializedPrimaryKey
• serializer
• setter
• strategy
• targetKey
• type
• unique
• unsigned
• updateRule
• version
• where

Properties

~options

~options: Options

optional~type

~type?: { value: Value }

Type declaration

• value: Value

Methods

$type

• $type<T>(): PropertyChain<T, Options>
• $type<Runtime, Raw, Serialized>(): PropertyChain<IType<Runtime, Raw, Serialized>, Options>

• Returns PropertyChain<T, Options>

accessor

• accessor(accessor): PropertyChain<Value, Options>

• Parameters

  • optionalaccessor: string | boolean

  Returns PropertyChain<Value, Options>

array

• array(): HasKind<Options, enum | embedded> extends true ? PropertyChain<Value, Omit<Options, array> & { array: true }> : never

• Returns HasKind<Options, enum | embedded> extends true ? PropertyChain<Value, Omit<Options, array> & { array: true }> : never

autoincrement

• autoincrement(): PropertyChain<Value, Omit<Options, autoincrement> & { autoincrement: true }>
• autoincrement(autoincrement): PropertyChain<Value, Omit<Options, autoincrement> & { autoincrement: false }>

• Returns PropertyChain<Value, Omit<Options, autoincrement> & { autoincrement: true }>

cascade

• cascade(...cascade): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • rest...cascade: Cascade[]

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

check

• check(check): PropertyChain<Value, Options>

• Parameters

  • check: string | CheckCallback<any>

  Returns PropertyChain<Value, Options>

columnType

• columnType(columnType): PropertyChain<Value, Options>

• Parameters

  • columnType: AnyString | ColumnType

  Returns PropertyChain<Value, Options>

columnTypes

• columnTypes(...columnTypes): PropertyChain<Value, Options>

• Parameters

  • rest...columnTypes: (AnyString | ColumnType)[]

  Returns PropertyChain<Value, Options>

comment

• comment(comment): PropertyChain<Value, Options>

• Parameters

  • comment: string

  Returns PropertyChain<Value, Options>

concurrencyCheck

• concurrencyCheck(concurrencyCheck): PropertyChain<Value, Options>

• Parameters

  • optionalconcurrencyCheck: boolean

  Returns PropertyChain<Value, Options>

createForeignKeyConstraint

• createForeignKeyConstraint(createForeignKeyConstraint): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • optionalcreateForeignKeyConstraint: boolean

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

customOrder

• customOrder(...customOrder): PropertyChain<Value, Options>

• Parameters

  • rest...customOrder: string[] | number[] | boolean[]

  Returns PropertyChain<Value, Options>

default

• default(defaultValue): PropertyChain<Value, Omit<Options, default> & { default: any }>

• Parameters

  • defaultValue: null | string | number | boolean | RawQueryFragment<string> | Date | string[] | number[]

  Returns PropertyChain<Value, Omit<Options, default> & { default: any }>

defaultRaw

• defaultRaw(defaultRaw): PropertyChain<Value, Options & { defaultRaw: string }>

• Parameters

  • defaultRaw: string

  Returns PropertyChain<Value, Options & { defaultRaw: string }>

deferMode

• deferMode(deferMode): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • deferMode: DeferMode | immediate | deferred

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

deleteRule

• deleteRule(deleteRule): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • deleteRule: AnyString | cascade | no action | set null | set default

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

discriminator

• discriminator(discriminator): HasKind<Options, m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • discriminator: string

  Returns HasKind<Options, m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

discriminatorMap

• discriminatorMap(discriminatorMap): HasKind<Options, m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • discriminatorMap: Dictionary<string>

  Returns HasKind<Options, m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

eager

• eager(eager): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • optionaleager: boolean

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

extra

• extra(extra): PropertyChain<Value, Options>

• Parameters

  • extra: string

  Returns PropertyChain<Value, Options>

fieldName

• fieldName<T>(fieldName): PropertyChain<Value, Omit<Options, fieldName> & { fieldName: T }>

• Parameters

  • fieldName: T

  Returns PropertyChain<Value, Omit<Options, fieldName> & { fieldName: T }>

fieldNames

• fieldNames(...fieldNames): PropertyChain<Value, Options>

• Parameters

  • rest...fieldNames: string[]

  Returns PropertyChain<Value, Options>

filters

• filters(filters): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • filters: FilterOptions

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

fixedOrder

• fixedOrder(fixedOrder): HasKind<Options, m:n> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • optionalfixedOrder: boolean

  Returns HasKind<Options, m:n> extends true ? PropertyChain<Value, Options> : never

fixedOrderColumn

• fixedOrderColumn(fixedOrderColumn): HasKind<Options, m:n> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • fixedOrderColumn: string

  Returns HasKind<Options, m:n> extends true ? PropertyChain<Value, Options> : never

foreignKeyName

• foreignKeyName(foreignKeyName): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • foreignKeyName: string

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

formula

• formula(formula): PropertyChain<Value, Omit<Options, formula> & { formula: any }>

• Parameters

  • formula: string | FormulaCallback<any>

  Returns PropertyChain<Value, Omit<Options, formula> & { formula: any }>

generated

• generated(generated): PropertyChain<Value, Options>

• Parameters

  • generated: string | GeneratedColumnCallback<any>

  Returns PropertyChain<Value, Options>

getter

• getter(getter): PropertyChain<Value, Options>

• Parameters

  • optionalgetter: boolean

  Returns PropertyChain<Value, Options>

getterName

• getterName(getterName): PropertyChain<Value, Options>

• Parameters

  • getterName: string

  Returns PropertyChain<Value, Options>

groups

• groups(...groups): PropertyChain<Value, Options>

• Parameters

  • rest...groups: string[]

  Returns PropertyChain<Value, Options>

hidden

• hidden(): PropertyChain<Value, Omit<Options, hidden> & { hidden: true }>

• Returns PropertyChain<Value, Omit<Options, hidden> & { hidden: true }>

hydrate

• hydrate(hydrate): PropertyChain<Value, Options>

• Parameters

  • optionalhydrate: boolean

  Returns PropertyChain<Value, Options>

ignoreSchemaChanges

• ignoreSchemaChanges(...ignoreSchemaChanges): PropertyChain<Value, Options>

• Parameters

  • rest...ignoreSchemaChanges: (type | extra | default)[]

  Returns PropertyChain<Value, Options>

index

• index(index): PropertyChain<Value, Options>

• Parameters

  • optionalindex: string | boolean

  Returns PropertyChain<Value, Options>

inversedBy

• inversedBy(inversedBy): HasKind<Options, m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • inversedBy: (keyof Value & string) | (e) => any

  Returns HasKind<Options, m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

inverseJoinColumn

• inverseJoinColumn(inverseJoinColumn): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • inverseJoinColumn: string

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

inverseJoinColumns

• inverseJoinColumns(...inverseJoinColumns): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • rest...inverseJoinColumns: string[]

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

joinColumn

• joinColumn(joinColumn): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • joinColumn: string

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

joinColumns

• joinColumns(...joinColumns): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • rest...joinColumns: string[]

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

lazy

• lazy(): PropertyChain<Value, Options>

• Returns PropertyChain<Value, Options>

length

• length(length): PropertyChain<Value, Options>

• Parameters

  • length: number

  Returns PropertyChain<Value, Options>

mappedBy

• mappedBy(mappedBy): HasKind<Options, 1:m | m:n | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • mappedBy: (keyof Value & string) | (e) => any

  Returns HasKind<Options, 1:m | m:n | 1:1> extends true ? PropertyChain<Value, Options> : never

mapToPk

• mapToPk(): HasKind<Options, m:1 | 1:1> extends true ? PropertyChain<Value, Omit<Options, mapToPk> & { mapToPk: true }> : never

• Returns HasKind<Options, m:1 | 1:1> extends true ? PropertyChain<Value, Omit<Options, mapToPk> & { mapToPk: true }> : never

name

• name<T>(name): PropertyChain<Value, Omit<Options, fieldName> & { fieldName: T }>

• Parameters

  • name: T

  Returns PropertyChain<Value, Omit<Options, fieldName> & { fieldName: T }>

nativeEnumName

• nativeEnumName(nativeEnumName): HasKind<Options, enum> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • nativeEnumName: string

  Returns HasKind<Options, enum> extends true ? PropertyChain<Value, Options> : never

nullable

• nullable(): PropertyChain<Value, Omit<Options, nullable> & { nullable: true }>

• Returns PropertyChain<Value, Omit<Options, nullable> & { nullable: true }>

object

• object(object): HasKind<Options, embedded> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • optionalobject: boolean

  Returns HasKind<Options, embedded> extends true ? PropertyChain<Value, Options> : never

onCreate

• onCreate(onCreate): PropertyChain<Value, Options & { onCreate: (...args) => any }>

• Parameters

  • onCreate: (entity, em) => Value

  Returns PropertyChain<Value, Options & { onCreate: (...args) => any }>

onUpdate

• onUpdate(onUpdate): PropertyChain<Value, Options>

• Parameters

  • onUpdate: (entity, em) => Value

  Returns PropertyChain<Value, Options>

orderBy

• orderBy(...orderBy): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • rest...orderBy: QueryOrderMap<object>[]

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

orphanRemoval

• orphanRemoval(orphanRemoval): HasKind<Options, 1:m | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • optionalorphanRemoval: boolean

  Returns HasKind<Options, 1:m | 1:1> extends true ? PropertyChain<Value, Options> : never

ownColumns

• ownColumns(...ownColumns): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • rest...ownColumns: string[]

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

owner

• owner(): HasKind<Options, m:n | 1:1> extends true ? PropertyChain<Value, Omit<Options, owner> & { owner: true }> : never

• Returns HasKind<Options, m:n | 1:1> extends true ? PropertyChain<Value, Omit<Options, owner> & { owner: true }> : never

persist

• persist(): PropertyChain<Value, Omit<Options, persist> & { persist: true }>
• persist(persist): PropertyChain<Value, Omit<Options, persist> & { persist: false }>

• Returns PropertyChain<Value, Omit<Options, persist> & { persist: true }>

pivotEntity

• pivotEntity(pivotEntity): HasKind<Options, m:n> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • pivotEntity: () => EntityName

  Returns HasKind<Options, m:n> extends true ? PropertyChain<Value, Options> : never

pivotTable

• pivotTable(pivotTable): HasKind<Options, m:n> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • pivotTable: string

  Returns HasKind<Options, m:n> extends true ? PropertyChain<Value, Options> : never

precision

• precision(precision): PropertyChain<Value, Options>

• Parameters

  • precision: number

  Returns PropertyChain<Value, Options>

prefix

• prefix(prefix): HasKind<Options, embedded> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • prefix: string | boolean

  Returns HasKind<Options, embedded> extends true ? PropertyChain<Value, Options> : never

prefixMode

• prefixMode(prefixMode): HasKind<Options, embedded> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • prefixMode: EmbeddedPrefixMode

  Returns HasKind<Options, embedded> extends true ? PropertyChain<Value, Options> : never

primary

• primary(): PropertyChain<Value, Omit<Options, primary> & { primary: true }>

• Returns PropertyChain<Value, Omit<Options, primary> & { primary: true }>

ref

• ref(): PropertyChain<Value, Omit<Options, ref> & { ref: true }>

• Returns PropertyChain<Value, Omit<Options, ref> & { ref: true }>

referenceColumnName

• referenceColumnName(referenceColumnName): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • referenceColumnName: string

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

referencedColumnNames

• referencedColumnNames(...referencedColumnNames): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • rest...referencedColumnNames: string[]

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

returning

• returning(returning): PropertyChain<Value, Options>

• Parameters

  • optionalreturning: boolean

  Returns PropertyChain<Value, Options>

runtimeType

• runtimeType(runtimeType): PropertyChain<Value, Options>

• Parameters

  • runtimeType: string

  Returns PropertyChain<Value, Options>

scale

• scale(scale): PropertyChain<Value, Options>

• Parameters

  • scale: number

  Returns PropertyChain<Value, Options>

serializedName

• serializedName(serializedName): PropertyChain<Value, Options>

• Parameters

  • serializedName: string

  Returns PropertyChain<Value, Options>

serializedPrimaryKey

• serializedPrimaryKey(serializedPrimaryKey): PropertyChain<Value, Options>

• Parameters

  • optionalserializedPrimaryKey: boolean

  Returns PropertyChain<Value, Options>

serializer

• serializer(serializer): PropertyChain<Value, Options>

• Parameters

  • serializer: (value, options) => any

  Returns PropertyChain<Value, Options>

setter

• setter(setter): PropertyChain<Value, Options>

• Parameters

  • optionalsetter: boolean

  Returns PropertyChain<Value, Options>

strategy

• strategy(strategy): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • strategy: LoadStrategy | select-in | joined | balanced

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

targetKey

• targetKey(targetKey): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • targetKey: keyof Value & string

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

type

• type(type): PropertyChain<Value, Options>

• Parameters

  • type: undefined | string | AnyString | Date | uint8array | array | enumArray | unknown | Type<any, any> | Constructor<Partial<any>> | ObjectId | Constructor<Type<any, any>> | () => unknown | ColumnType

  Returns PropertyChain<Value, Options>

unique

• unique(unique): PropertyChain<Value, Options>

• Parameters

  • optionalunique: string | boolean

  Returns PropertyChain<Value, Options>

unsigned

• unsigned(unsigned): PropertyChain<Value, Options>

• Parameters

  • optionalunsigned: boolean

  Returns PropertyChain<Value, Options>

updateRule

• updateRule(updateRule): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • updateRule: AnyString | cascade | no action | set null | set default

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

version

• version(): PropertyChain<Value, Omit<Options, version> & { version: true }>

• Returns PropertyChain<Value, Omit<Options, version> & { version: true }>

where

• where(...where): HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never

• Parameters

  • rest...where: FilterQuery<object>[]

  Returns HasKind<Options, 1:m | m:n | m:1 | 1:1> extends true ? PropertyChain<Value, Options> : never