Utils

Index

Constructors

• constructor

Properties

• PK_SEPARATOR

Methods

• absolutePath
• asArray
• callCompiledFunction
• className
• copy
• createFunction
• defaultValue
• detectTsNode
• diff
• dropUndefinedProperties
• dynamicImport
• dynamicImportProvider
• entries
• equals
• extractChildElements
• extractEnumValues
• extractPK
• fileURLToPath
• findDuplicates
• flatten
• getCompositeKeyHash
• getCompositeKeyValue
• getGlobalStorage
• getObjectKeysSize
• getObjectType
• getOrderedPrimaryKeys
• getORMVersion
• getParamNames
• getPrimaryKeyCond
• getPrimaryKeyCondFromArray
• getPrimaryKeyHash
• getPrimaryKeyValues
• getRootEntity
• hash
• hasNestedKey
• hasObjectKeys
• isArrayOperator
• isCollection
• isDefined
• isEmpty
• isEntity
• isGroupOperator
• isIterable
• isJsonKeyOperator
• isNotObject
• isNumber
• isObject
• isObjectID
• isOperator
• isPlainObject
• isPrimaryKey
• isRawSql
• isScalarReference
• isString
• keys
• lookupPathFromDecorator
• mapFlatCompositePrimaryKey
• merge
• mergeConfig
• normalizePath
• parseArgs
• pathExists
• primaryKeyToObject
• propertyDecoratorReturnValue
• randomInt
• relativePath
• removeDuplicates
• renameKey
• requireFrom
• runIfNotEmpty
• runSerial
• setDynamicImportProvider
• setPayloadProperty
• splitPrimaryKeys
• stripRelativePath
• tokenize
• tryRequire
• unique
• unwrapProperty
• values
• xor

Constructors

constructor

• new Utils(): Utils

• Returns Utils

Properties

staticreadonlyPK_SEPARATOR

PK_SEPARATOR: ~~~ = '~~~'

Methods

staticabsolutePath

• absolutePath(path: string, baseDir?: string): string

• Computes the absolute path to for the given path relative to the provided base directory. If either path or baseDir are file: URLs, they are converted to local paths.

  ---

  Parameters

  • path: string

  • baseDir: string = ...

  Returns string

staticasArray

• asArray(data?: T | readonly T[] | Iterable<T, any, any>, strict?: boolean): T[]

• Normalize the argument to always be an array.

  ---

  Parameters

  • optionaldata: T | readonly T[] | Iterable<T, any, any>

  • strict: boolean = false

  Returns T[]

staticcallCompiledFunction

• callCompiledFunction(fn: (...args: T) => R, ...args: T): R

• Parameters

  • fn: (...args: T) => R

  • rest...args: T

  Returns R

staticclassName

• className(classOrName: EntityName<T>): string

• Gets string name of given class.

  ---

  Parameters

  • classOrName: EntityName<T>

  Returns string

staticcopy

• copy(entity: T, respectCustomCloneMethod?: boolean): T

• Creates deep copy of given object.

  ---

  Parameters

  • entity: T

  • respectCustomCloneMethod: boolean = true

  Returns T

staticcreateFunction

• createFunction(context: Map<string, any>, code: string): any

• Parameters

  • context: Map<string, any>

  • code: string

  Returns any

staticdefaultValue

• defaultValue(prop: T, option: keyof T, defaultValue: any): void

• Parameters

  • prop: T

  • option: keyof T

  • defaultValue: any

  Returns void

staticdetectTsNode

• detectTsNode(): boolean

• Tries to detect ts-node runtime.

  ---

  Returns boolean

staticdiff

• diff(a: Dictionary, b: Dictionary): Record<string | number, any>

• Computes difference between two objects, ignoring items missing in b.

  ---

  Parameters

  • a: Dictionary

  • b: Dictionary

  Returns Record<string | number, any>

staticdropUndefinedProperties

• dropUndefinedProperties(o: any, value?: null, visited?: Set<unknown>): void

• Removes undefined properties (recursively) so they are not saved as nulls

  ---

  Parameters

  • o: any

  • optionalvalue: null

  • visited: Set<unknown> = ...

  Returns void

staticdynamicImport

• dynamicImport(id: string): Promise<T>

• Parameters

  • id: string

  Returns Promise<T>

staticdynamicImportProvider

• dynamicImportProvider(id: string): Promise<any>

• Parameters

  • id: string

  Returns Promise<any>

staticentries

• entries(obj: T): [keyof T, T[keyof T]][]

• Parameters

  • obj: T

  Returns [keyof T, T[keyof T]][]

staticequals

• equals(a: any, b: any): boolean

• Checks if arguments are deeply (but not strictly) equal.

  ---

  Parameters

  • a: any

  • b: any

  Returns boolean

staticextractChildElements

• extractChildElements(items: string[], prefix: string, allSymbol?: string): string[]

• Parameters

  • items: string[]

  • prefix: string

  • optionalallSymbol: string

  Returns string[]

staticextractEnumValues

• extractEnumValues(target: Dictionary): (string | number)[]

• Extracts all possible values of a TS enum. Works with both string and numeric enums.

  ---

  Parameters

  • target: Dictionary

  Returns (string | number)[]

staticextractPK

• extractPK(data: any, meta?: EntityMetadata<T>, strict?: boolean): null | string | (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T)

• Extracts primary key from data. Accepts objects or primary keys directly.

  ---

  Parameters

  • data: any

  • optionalmeta: EntityMetadata<T>

  • strict: boolean = false

  Returns null | string | (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T)

staticfileURLToPath

• fileURLToPath(url: string | URL): string

• Parameters

  • url: string | URL

  Returns string

staticfindDuplicates

• findDuplicates(items: T[]): T[]

• Parameters

  • items: T[]

  Returns T[]

staticflatten

• flatten(arrays: T[][]): T[]

• Parameters

  • arrays: T[][]

  Returns T[]

staticgetCompositeKeyHash

• getCompositeKeyHash(data: EntityData<T>, meta: EntityMetadata<T>, convertCustomTypes?: boolean, platform?: Platform, flat?: boolean): string

• Parameters

  • data: EntityData<T>

  • meta: EntityMetadata<T>

  • convertCustomTypes: boolean = false

  • optionalplatform: Platform

  • flat: boolean = false

  Returns string

staticgetCompositeKeyValue

• getCompositeKeyValue(data: EntityData<T>, meta: EntityMetadata<T>, convertCustomTypes?: boolean | convertToDatabaseValue | convertToJSValue, platform?: Platform): Primary<T>

• Parameters

  • data: EntityData<T>

  • meta: EntityMetadata<T>

  • convertCustomTypes: boolean | convertToDatabaseValue | convertToJSValue = false

  • optionalplatform: Platform

  Returns Primary<T>

staticgetGlobalStorage

• getGlobalStorage(namespace: string): Dictionary

• Parameters

  • namespace: string

  Returns Dictionary

staticgetObjectKeysSize

• getObjectKeysSize(object: Dictionary): number

• Returns the number of properties on obj. This is 20x faster than Object.keys(obj).length.

  @see

  https://github.com/deepkit/deepkit-framework/blob/master/packages/core/src/core.ts

  ---

  Parameters

  • object: Dictionary

  Returns number

staticgetObjectType

• getObjectType(value: any): string

• Gets the type of the argument.

  ---

  Parameters

  • value: any

  Returns string

staticgetOrderedPrimaryKeys

• getOrderedPrimaryKeys(id: Primary<T> | Record<string, Primary<T>>, meta: EntityMetadata<T>, platform?: Platform, convertCustomTypes?: boolean): Primary<T>[]

• Parameters

  • id: Primary<T> | Record<string, Primary<T>>

  • meta: EntityMetadata<T>

  • optionalplatform: Platform

  • convertCustomTypes: boolean = false

  Returns Primary<T>[]

staticgetORMVersion

• getORMVersion(): string

• Returns string

staticgetParamNames

• getParamNames(func: string | { toString: any } | { type: string; value: string }[], methodName?: string): string[]

• Returns array of functions argument names. Uses esprima for source code analysis.

  ---

  Parameters

  • func: string | { toString: any } | { type: string; value: string }[]

  • toString:

  • optionalmethodName: string

  Returns string[]

staticgetPrimaryKeyCond

• getPrimaryKeyCond(entity: T, primaryKeys: EntityKey<T>[]): null | Record<string, Primary<T>>

• Parameters

  • entity: T

  • primaryKeys: EntityKey<T>[]

  Returns null | Record<string, Primary<T>>

staticgetPrimaryKeyCondFromArray

• getPrimaryKeyCondFromArray(pks: (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T)[], meta: EntityMetadata<T>): Record<string, T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T>

• Parameters

  • pks: (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T)[]

  • meta: EntityMetadata<T>

  Returns Record<string, T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T>

staticgetPrimaryKeyHash

• getPrimaryKeyHash(pks: (string | Date | Buffer)[]): string

• Parameters

  • pks: (string | Date | Buffer)[]

  Returns string

staticgetPrimaryKeyValues

• getPrimaryKeyValues(entity: T, primaryKeys: string[], allowScalar?: boolean, convertCustomTypes?: boolean): any

• Parameters

  • entity: T

  • primaryKeys: string[]

  • allowScalar: boolean = false

  • convertCustomTypes: boolean = false

  Returns any

staticgetRootEntity

• getRootEntity(metadata: IMetadataStorage, meta: EntityMetadata<any>): EntityMetadata<any>

• Parameters

  • metadata: IMetadataStorage

  • meta: EntityMetadata<any>

  Returns EntityMetadata<any>

statichash

• hash(data: string, length?: number): string

• Parameters

  • data: string

  • optionallength: number

  Returns string

statichasNestedKey

• hasNestedKey(object: unknown, key: string): boolean

• Parameters

  • object: unknown

  • key: string

  Returns boolean

statichasObjectKeys

• hasObjectKeys(object: Dictionary): boolean

• Returns true if obj has at least one property. This is 20x faster than Object.keys(obj).length.

  @see

  https://github.com/deepkit/deepkit-framework/blob/master/packages/core/src/core.ts

  ---

  Parameters

  • object: Dictionary

  Returns boolean

staticisArrayOperator

• isArrayOperator(key: PropertyKey): boolean

• Parameters

  • key: PropertyKey

  Returns boolean

staticisCollection

• isCollection(item: any): item is Collection<T, O>

• Parameters

  • item: any

  Returns item is Collection<T, O>

staticisDefined

• isDefined(data: any): data is T

• Checks if the argument is not undefined

  ---

  Parameters

  • data: any

  Returns data is T

staticisEmpty

• isEmpty(data: any): boolean

• Checks whether the argument is empty (array without items, object without keys or falsy value).

  ---

  Parameters

  • data: any

  Returns boolean

staticisEntity

• isEntity(data: any, allowReference?: boolean): data is T & {}

• Checks whether given object is an entity instance.

  ---

  Parameters

  • data: any

  • allowReference: boolean = false

  Returns data is T & {}

staticisGroupOperator

• isGroupOperator(key: PropertyKey): boolean

• Parameters

  • key: PropertyKey

  Returns boolean

staticisIterable

• isIterable(value: unknown): value is Iterable<T, any, any>

• Checks if the value is iterable, but considers strings and buffers as not iterable.

  ---

  Parameters

  • value: unknown

  Returns value is Iterable<T, any, any>

staticisJsonKeyOperator

• isJsonKeyOperator(key: PropertyKey): boolean

• Parameters

  • key: PropertyKey

  Returns boolean

staticisNotObject

• isNotObject(o: any, not: any[]): o is T

• Checks if the argument is instance of Object, but not one of the blacklisted types. Returns false for arrays.

  ---

  Parameters

  • o: any

  • not: any[]

  Returns o is T

staticisNumber

• isNumber(s: any): s is T

• Checks if the argument is number

  ---

  Parameters

  • s: any

  Returns s is T

staticisObject

• isObject(o: any): o is T

• Checks if the argument is instance of Object. Returns false for arrays.

  ---

  Parameters

  • o: any

  Returns o is T

staticisObjectID

• isObjectID(key: any): boolean

• Checks whether the argument is ObjectId instance

  ---

  Parameters

  • key: any

  Returns boolean

staticisOperator

• isOperator(key: PropertyKey, includeGroupOperators?: boolean): boolean

• Parameters

  • key: PropertyKey

  • includeGroupOperators: boolean = true

  Returns boolean

staticisPlainObject

• isPlainObject(value: any): value is T

• Checks whether the value is POJO (e.g. { foo: 'bar' }, and not instance of Foo)

  ---

  Parameters

  • value: any

  Returns value is T

staticisPrimaryKey

• isPrimaryKey(key: any, allowComposite?: boolean): key is Primary<T>

• Checks whether the argument looks like primary key (string, number or ObjectId).

  ---

  Parameters

  • key: any

  • allowComposite: boolean = false

  Returns key is Primary<T>

staticisRawSql

• isRawSql(value: unknown): value is T

• Parameters

  • value: unknown

  Returns value is T

staticisScalarReference

• isScalarReference(data: any, allowReference?: boolean): data is ScalarReference<any>

• Checks whether given object is a scalar reference.

  ---

  Parameters

  • data: any

  • allowReference: boolean = false

  Returns data is ScalarReference<any>

staticisString

• isString(s: any): s is string

• Checks if the argument is string

  ---

  Parameters

  • s: any

  Returns s is string

statickeys

• keys(obj: T): keyof T[]

• Parameters

  • obj: T

  Returns keyof T[]

staticlookupPathFromDecorator

• lookupPathFromDecorator(name: string, stack?: string[]): string

• Uses some dark magic to get source path to caller where decorator is used. Analyses stack trace of error created inside the function call.

  ---

  Parameters

  • name: string

  • optionalstack: string[]

  Returns string

staticmapFlatCompositePrimaryKey

• mapFlatCompositePrimaryKey(fk: any[], prop: EntityProperty<any, any>, fieldNames?: string[], idx?: number): any

• Maps nested FKs from [1, 2, 3] to [1, [2, 3]].

  ---

  Parameters

  • fk: any[]

  • prop: EntityProperty<any, any>

  • fieldNames: string[] = prop.fieldNames

  • idx: number = 0

  Returns any

staticmerge

• merge(target: any, ...sources: any[]): any

• Merges all sources into the target recursively.

  ---

  Parameters

  • target: any

  • rest...sources: any[]

  Returns any

staticmergeConfig

• mergeConfig(target: any, ...sources: any[]): any

• Merges all sources into the target recursively. Ignores undefined values.

  ---

  Parameters

  • target: any

  • rest...sources: any[]

  Returns any

staticnormalizePath

• normalizePath(...parts: string[]): string

• Resolves and normalizes a series of path parts relative to each preceding part. If any part is a file: URL, it is converted to a local path. If any part is an absolute path, it replaces preceding paths (similar to path.resolve in NodeJS). Trailing directory separators are removed, and all directory separators are converted to POSIX-style separators (/).

  ---

  Parameters

  • rest...parts: string[]

  Returns string

staticparseArgs

• parseArgs(): T

• simple process.argv parser, supports only properties with long names, prefixed with --

  ---

  Returns T

staticpathExists

• pathExists(path: string, options?: GlobbyOptions): Promise<boolean>

• Parameters

  • path: string

  • options: GlobbyOptions = {}

  Returns Promise<boolean>

staticprimaryKeyToObject

• primaryKeyToObject(meta: EntityMetadata<T>, primaryKey: T | Primary<T>, visible?: keyof T[]): T

• Parameters

  • meta: EntityMetadata<T>

  • primaryKey: T | Primary<T>

  • optionalvisible: keyof T[]

  Returns T

staticpropertyDecoratorReturnValue

• propertyDecoratorReturnValue(): any

• @see

  https://github.com/mikro-orm/mikro-orm/issues/840

  ---

  Returns any

staticrandomInt

• randomInt(min: number, max: number): number

• Parameters

  • min: number

  • max: number

  Returns number

staticrelativePath

• relativePath(path: string, relativeTo: string): string

• Determines the relative path between two paths. If either path is a file: URL, it is converted to a local path.

  ---

  Parameters

  • path: string

  • relativeTo: string

  Returns string

staticremoveDuplicates

• removeDuplicates(items: T[]): T[]

• Parameters

  • items: T[]

  Returns T[]

staticrenameKey

• renameKey(payload: T, from: string | keyof T, to: string): void

• Renames object key, keeps order of properties.

  ---

  Parameters

  • payload: T

  • from: string | keyof T

  • to: string

  Returns void

staticrequireFrom

• requireFrom(id: string, from?: string): T

• Require a module from a specific location

  ---

  Parameters

  • id: string

    The module to require

  • optionalfrom: string = ...

    Location to start the node resolution

  Returns T

staticrunIfNotEmpty

• runIfNotEmpty(clause: () => any, data: any): void

• Parameters

  • clause: () => any

  • data: any

  Returns void

staticrunSerial

• runSerial(items: Iterable<U, any, any>, cb: (item: U) => Promise<T>): Promise<T[]>

• Executes the cb promise serially on every element of the items array and returns array of resolved values.

  ---

  Parameters

  • items: Iterable<U, any, any>

  • cb: (item: U) => Promise<T>

  Returns Promise<T[]>

staticsetDynamicImportProvider

• setDynamicImportProvider(provider: (id: string) => Promise<unknown>): void

• Parameters

  • provider: (id: string) => Promise<unknown>

  Returns void

staticsetPayloadProperty

• setPayloadProperty(entity: EntityDictionary<T>, meta: EntityMetadata<T>, prop: EntityProperty<T, any>, value: unknown, idx: number[]): void

• Parameters

  • entity: EntityDictionary<T>

  • meta: EntityMetadata<T>

  • prop: EntityProperty<T, any>

  • value: unknown

  • idx: number[]

  Returns void

staticsplitPrimaryKeys

• splitPrimaryKeys(key: string): EntityKey<T>[]

• Parameters

  • key: string

  Returns EntityKey<T>[]

staticstripRelativePath

• stripRelativePath(str: string): string

• Parameters

  • str: string

  Returns string

statictokenize

• tokenize(func: string | { toString: any } | { type: string; value: string }[]): { type: string; value: string }[]

• Returns array of functions argument names. Uses esprima for source code analysis.

  ---

  Parameters

  • func: string | { toString: any } | { type: string; value: string }[]

  • toString:

  Returns { type: string; value: string }[]

statictryRequire

• tryRequire(__namedParameters: { allowError?: string; from?: string; module: string; warning: string }): undefined | T

• Parameters

  • __namedParameters: { allowError?: string; from?: string; module: string; warning: string }

  • optionalallowError: string

  • optionalfrom: string

  • module: string

  • warning: string

  Returns undefined | T

staticunique

• unique(items: T[]): T[]

• Gets array without duplicates.

  ---

  Parameters

  • items: T[]

  Returns T[]

staticunwrapProperty

• unwrapProperty(entity: T, meta: EntityMetadata<T>, prop: EntityProperty<T, any>, payload?: boolean): [unknown, number[]][]

• Parameters

  • entity: T

  • meta: EntityMetadata<T>

  • prop: EntityProperty<T, any>

  • payload: boolean = false

  Returns [unknown, number[]][]

staticvalues

• values(obj: T): T[keyof T][]

• Parameters

  • obj: T

  Returns T[keyof T][]

staticxor

• xor(a: boolean, b: boolean): boolean

• Parameters

  • a: boolean

  • b: boolean

  Returns boolean