Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace oTools

Index

Interfaces

Variables

Functions

Variables

Const default

default: { iterate: typeof iterate; iterateChunk: typeof iterateChunk; iterateKeys: typeof iterateKeys; iterateParallel: typeof iterateParallel; iterateParallelLimit: typeof iterateParallelLimit; GUID: any; UID: any; arrayToObject: any; delay: any; escapeRegExp: any; isArray: any; isAsyncFunction: any; isBoolean: any; isEmptyArray: any; isEmptyObject: any; isFloat: any; isFunction: any; isGUID: any; isGUIDv4: any; isInteger: any; isIterable: any; isJSON: any; isMap: any; isNativeObject: any; isNull: any; isNumber: any; isObject: any; isPositiveInteger: any; isRegExp: any; isSet: any; isString: any; isSymbol: any; isUndefined: any; mapToArray: any; nop: any; nop$: any; objectToArray: any; random: any; setDefaults: any; sortObject: any; toArray: any }

Type declaration

  • iterate: typeof iterate
  • iterateChunk: typeof iterateChunk
  • iterateKeys: typeof iterateKeys
  • iterateParallel: typeof iterateParallel
  • iterateParallelLimit: typeof iterateParallelLimit
  • GUID:function
    • GUID(mask?: string): string

    • Parameters

      • Optional mask: string

      Returns string

  • UID:function
    • UID(prefix?: string, mask?: string): string

    • Parameters

      • Optional prefix: string
      • Optional mask: string

      Returns string

  • arrayToObject:function
    • arrayToObject(value: any[], toKeys?: boolean): {}

    • Parameters

      • value: any[]
      • Optional toKeys: boolean

      Returns {}

      • [key: string]: any
  • delay:function
    • delay(ms?: number): Promise<void>

    • Parameters

      • Optional ms: number

      Returns Promise<void>

  • escapeRegExp:function
    • escapeRegExp(value: string): string

    • Parameters

      • value: string

      Returns string

  • isArray:function
    • isArray(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isAsyncFunction:function
    • isAsyncFunction(value: any, asyncPattern?: string): boolean

    • Parameters

      • value: any
      • Optional asyncPattern: string

      Returns boolean

  • isBoolean:function
    • isBoolean(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isEmptyArray:function
    • isEmptyArray(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isEmptyObject:function
    • isEmptyObject(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isFloat:function
    • isFloat(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isFunction:function
    • isFunction(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isGUID:function
    • isGUID(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isGUIDv4:function
    • isGUIDv4(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isInteger:function
    • isInteger(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isIterable:function
    • isIterable(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isJSON:function
    • isJSON(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isMap:function
    • isMap(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isNativeObject:function
    • isNativeObject(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isNull:function
    • isNull(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isNumber:function
    • isNumber(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isObject:function
    • isObject(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isPositiveInteger:function
    • isPositiveInteger(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isRegExp:function
    • isRegExp(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isSet:function
    • isSet(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isString:function
    • isString(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • isSymbol:function
    • isSymbol(value: any, name?: string | boolean): boolean

    • Parameters

      • value: any
      • Optional name: string | boolean

      Returns boolean

  • isUndefined:function
    • isUndefined(value: any): boolean

    • Parameters

      • value: any

      Returns boolean

  • mapToArray:function
    • mapToArray<T_2, K>(value: Map<T_2, K>): [T_2, K][]

    • Type parameters

      • T_2 = any

      • K = any

      Parameters

      • value: Map<T_2, K>

      Returns [T_2, K][]

  • nop:function
    • nop(): void

    • Returns void

  • nop$:function
    • nop$(): Promise<void>

    • Returns Promise<void>

  • objectToArray:function
    • objectToArray(value: object, toKeys?: boolean): any[]

    • Parameters

      • value: object
      • Optional toKeys: boolean

      Returns any[]

  • random:function
    • random(): number

    • Returns number

  • setDefaults:function
    • setDefaults(obj: {}, name: string | number, value?: any): object

    • Parameters

      • obj: {}
        • [key: string]: any
      • name: string | number
      • Optional value: any

      Returns object

  • sortObject:function
    • sortObject<T_1>(target: T_1, onlyNumIdx?: boolean): T_1

    • Type parameters

      • T_1: {} = {}

      Parameters

      • target: T_1
      • Optional onlyNumIdx: boolean

      Returns T_1

  • toArray:function
    • toArray<T>(value: T | T[]): T[]

    • Type parameters

      • T = any

      Parameters

      • value: T | T[]

      Returns T[]

Functions

GUID

  • GUID(mask?: string): string

  • [[include: guid.md]]

    Parameters

    • Optional mask: string

    Returns string

    GUIDv4 string

UID

  • UID(prefix?: string, mask?: string): string

  • Generate 128bit unique id

    Parameters

    • Optional prefix: string
    • Optional mask: string

    Returns string

arrayToObject

  • arrayToObject(value: any[], toKeys?: boolean): {}

  • [[include: TAnyArray-to-object.md]]

    Parameters

    • value: any[]
    • Optional toKeys: boolean

    Returns {}

    • [key: string]: any

delay

  • delay(ms?: number): Promise<void>

  • Waits for ms via async/await

    Parameters

    • Optional ms: number

      time to wait or 100

    Returns Promise<void>

escapeRegExp

  • escapeRegExp(value: string): string

  • Escapes all special RegExp characters

    Parameters

    • value: string

    Returns string

isArray

  • isArray(value: any): boolean

  • Is value an Array

    Parameters

    • value: any

    Returns boolean

isAsyncFunction

  • isAsyncFunction(value: any, asyncPattern?: string): boolean

  • Is value an AsyncFunction

    Parameters

    • value: any
    • Optional asyncPattern: string

    Returns boolean

isBoolean

  • isBoolean(value: any): boolean

  • Is value a boolean

    Parameters

    • value: any

    Returns boolean

isEmptyArray

  • isEmptyArray(value: any): boolean

  • Is value an Array with length == 0

    Parameters

    • value: any

    Returns boolean

isEmptyObject

  • isEmptyObject(value: any): boolean

  • Is value an object and without keys

    Parameters

    • value: any

    Returns boolean

isFloat

  • isFloat(value: any): boolean

  • Is valuse an Float

    Parameters

    • value: any

    Returns boolean

isFunction

  • isFunction(value: any): boolean

  • Is value a Function

    Parameters

    • value: any

    Returns boolean

isGUID

  • isGUID(value: any): boolean

  • Is value a valid GUID string

    Parameters

    • value: any

    Returns boolean

isGUIDv4

  • isGUIDv4(value: any): boolean

  • Is value a valid GUIDv4 string

    Parameters

    • value: any

    Returns boolean

isInteger

  • isInteger(value: any): boolean

  • Is value an Integer number

    Parameters

    • value: any

    Returns boolean

isIterable

  • isIterable(value: any): boolean

  • Is value iterable (object or Array with not zero length)

    Parameters

    • value: any

    Returns boolean

isJSON

  • isJSON(value: any): boolean

  • Is value a JSON and can be decoded as object

    Parameters

    • value: any

    Returns boolean

isMap

  • isMap(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isNativeObject

  • isNativeObject(value: any): boolean

  • Is value a Native Object

    Parameters

    • value: any

    Returns boolean

isNull

  • isNull(value: any): boolean

  • Is value a null

    Parameters

    • value: any

    Returns boolean

isNumber

  • isNumber(value: any): boolean

  • Is value a number

    Parameters

    • value: any

    Returns boolean

isObject

  • isObject(value: any): boolean

  • Is value an object

    Parameters

    • value: any

    Returns boolean

isPositiveInteger

  • isPositiveInteger(value: any): boolean

  • [[include: is-positive-integer.md]]

    Parameters

    • value: any

    Returns boolean

isRegExp

  • isRegExp(value: any): boolean

  • Is value a RegExp

    Parameters

    • value: any

    Returns boolean

isSet

  • isSet(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isString

  • isString(value: any): boolean

  • Is value a string

    Parameters

    • value: any

    Returns boolean

isSymbol

  • isSymbol(value: any, name?: string | boolean): boolean

  • Is value symbol

    Parameters

    • value: any
    • Optional name: string | boolean

    Returns boolean

isUndefined

  • isUndefined(value: any): boolean

  • Is value an undefined

    Parameters

    • value: any

    Returns boolean

iterate

  • iterate<ArrayType>(value: ArrayType[], callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void>): Promise<void>
  • iterate<ArrayType, CbRetType>(value: ArrayType[], callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterate<ArrayType, CbRetType>(value: ArrayType[], callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterate<ObjectType>(value: Record<RecordIndexes, ObjectType>, callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void>): Promise<void>
  • iterate<ObjectType, CbRetType>(value: Record<RecordIndexes, ObjectType>, callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterate<ObjectType, CbRetType>(value: Record<RecordIndexes, ObjectType>, callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterate(value: number, callback: (row: number, index: number, iteration: IIteration) => Promise<void>): Promise<void>
  • iterate<CbRetType>(value: number, callback: (row: number, index: number, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterate<CbRetType>(value: number, callback: (row: number, index: number, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterate<MapIndexType, MapValueType>(value: Map<MapIndexType, MapValueType>, callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void>): Promise<void>
  • iterate<MapIndexType, MapValueType, CbRetType>(value: Map<MapIndexType, MapValueType>, callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterate<MapIndexType, MapValueType, CbRetType>(value: Map<MapIndexType, MapValueType>, callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterate<SetValueType>(value: Set<SetValueType>, callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void>): Promise<void>
  • iterate<SetValueType, CbRetType>(value: Set<SetValueType>, callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterate<SetValueType, CbRetType>(value: Set<SetValueType>, callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterate<ArrayType>(value: ArrayType[], callback: (row: ArrayType, index: number, iteration: IIteration) => void): void
  • iterate<ArrayType, CbRetType>(value: ArrayType[], callback: (row: ArrayType, index: number, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterate<ArrayType, CbRetType>(value: ArrayType[], callback: (row: ArrayType, index: number, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>
  • iterate<ObjectType>(value: Record<RecordIndexes, ObjectType>, callback: (row: ObjectType, index: string, iteration: IIteration) => void): void
  • iterate<ObjectType, CbRetType>(value: Record<RecordIndexes, ObjectType>, callback: (row: ObjectType, index: string, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterate<ObjectType, CbRetType>(value: Record<RecordIndexes, ObjectType>, callback: (row: ObjectType, index: string, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>
  • iterate(value: number, callback: (row: number, index: number, iteration: IIteration) => void): void
  • iterate<CbRetType>(value: number, callback: (row: number, index: number, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterate<CbRetType>(value: number, callback: (row: number, index: number, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>
  • iterate<MapIndexType, MapValueType>(value: Map<MapIndexType, MapValueType>, callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => void): void
  • iterate<MapIndexType, MapValueType, CbRetType>(value: Map<MapIndexType, MapValueType>, callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterate<MapIndexType, MapValueType, CbRetType>(value: Map<MapIndexType, MapValueType>, callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>
  • iterate<SetValueType>(value: Set<SetValueType>, callback: (row: SetValueType, index: number, iteration: IIteration) => void): void
  • iterate<SetValueType, CbRetType>(value: Set<SetValueType>, callback: (row: SetValueType, index: number, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterate<SetValueType, CbRetType>(value: Set<SetValueType>, callback: (row: SetValueType, index: number, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>

  • [[include: iterate.md]]

    Type parameters

    • ArrayType

    Parameters

    • value: ArrayType[]
    • callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void>
        • (row: ArrayType, index: number, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • ArrayType

    • CbRetType

    Parameters

    • value: ArrayType[]
    • callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void | CbRetType>
        • (row: ArrayType, index: number, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • ArrayType

    • CbRetType

    Parameters

    • value: ArrayType[]
    • callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void | CbRetType>
        • (row: ArrayType, index: number, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Type parameters

    • ObjectType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void>
        • (row: ObjectType, index: string, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • ObjectType

    • CbRetType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void | CbRetType>
        • (row: ObjectType, index: string, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • ObjectType

    • CbRetType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void | CbRetType>
        • (row: ObjectType, index: string, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Parameters

    • value: number
    • callback: (row: number, index: number, iteration: IIteration) => Promise<void>
        • (row: number, index: number, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • CbRetType

    Parameters

    • value: number
    • callback: (row: number, index: number, iteration: IIteration) => Promise<void | CbRetType>
        • (row: number, index: number, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • CbRetType

    Parameters

    • value: number
    • callback: (row: number, index: number, iteration: IIteration) => Promise<void | CbRetType>
        • (row: number, index: number, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Type parameters

    • MapIndexType

    • MapValueType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void>
        • (row: MapValueType, index: MapIndexType, iteration: IIteration): Promise<void>

        • Parameters

          • row: MapValueType
          • index: MapIndexType
          • iteration: IIteration

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • MapIndexType

    • MapValueType

    • CbRetType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void | CbRetType>
        • (row: MapValueType, index: MapIndexType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          • row: MapValueType
          • index: MapIndexType
          • iteration: IIteration

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • MapIndexType

    • MapValueType

    • CbRetType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void | CbRetType>
        • (row: MapValueType, index: MapIndexType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          • row: MapValueType
          • index: MapIndexType
          • iteration: IIteration

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Type parameters

    • SetValueType

    Parameters

    • value: Set<SetValueType>
    • callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void>
        • (row: SetValueType, index: number, iteration: IIteration): Promise<void>

        • Parameters

          • row: SetValueType
          • index: number
          • iteration: IIteration

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • SetValueType

    • CbRetType

    Parameters

    • value: Set<SetValueType>
    • callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void | CbRetType>
        • (row: SetValueType, index: number, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          • row: SetValueType
          • index: number
          • iteration: IIteration

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • SetValueType

    • CbRetType

    Parameters

    • value: Set<SetValueType>
    • callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void | CbRetType>
        • (row: SetValueType, index: number, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          • row: SetValueType
          • index: number
          • iteration: IIteration

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Type parameters

    • ArrayType

    Parameters

    • value: ArrayType[]
    • callback: (row: ArrayType, index: number, iteration: IIteration) => void
        • (row: ArrayType, index: number, iteration: IIteration): void

        • Parameters

          Returns void

    Returns void

  • Type parameters

    • ArrayType

    • CbRetType

    Parameters

    • value: ArrayType[]
    • callback: (row: ArrayType, index: number, iteration: IIteration) => void | CbRetType
        • (row: ArrayType, index: number, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • ArrayType

    • CbRetType

    Parameters

    • value: ArrayType[]
    • callback: (row: ArrayType, index: number, iteration: IIteration) => void | CbRetType
        • (row: ArrayType, index: number, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

  • Type parameters

    • ObjectType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (row: ObjectType, index: string, iteration: IIteration) => void
        • (row: ObjectType, index: string, iteration: IIteration): void

        • Parameters

          Returns void

    Returns void

  • Type parameters

    • ObjectType

    • CbRetType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (row: ObjectType, index: string, iteration: IIteration) => void | CbRetType
        • (row: ObjectType, index: string, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • ObjectType

    • CbRetType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (row: ObjectType, index: string, iteration: IIteration) => void | CbRetType
        • (row: ObjectType, index: string, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

  • Parameters

    • value: number
    • callback: (row: number, index: number, iteration: IIteration) => void
        • (row: number, index: number, iteration: IIteration): void

        • Parameters

          Returns void

    Returns void

  • Type parameters

    • CbRetType

    Parameters

    • value: number
    • callback: (row: number, index: number, iteration: IIteration) => void | CbRetType
        • (row: number, index: number, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • CbRetType

    Parameters

    • value: number
    • callback: (row: number, index: number, iteration: IIteration) => void | CbRetType
        • (row: number, index: number, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

  • Type parameters

    • MapIndexType

    • MapValueType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => void
        • (row: MapValueType, index: MapIndexType, iteration: IIteration): void

        • Parameters

          • row: MapValueType
          • index: MapIndexType
          • iteration: IIteration

          Returns void

    Returns void

  • Type parameters

    • MapIndexType

    • MapValueType

    • CbRetType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => void | CbRetType
        • (row: MapValueType, index: MapIndexType, iteration: IIteration): void | CbRetType

        • Parameters

          • row: MapValueType
          • index: MapIndexType
          • iteration: IIteration

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • MapIndexType

    • MapValueType

    • CbRetType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => void | CbRetType
        • (row: MapValueType, index: MapIndexType, iteration: IIteration): void | CbRetType

        • Parameters

          • row: MapValueType
          • index: MapIndexType
          • iteration: IIteration

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

  • Type parameters

    • SetValueType

    Parameters

    • value: Set<SetValueType>
    • callback: (row: SetValueType, index: number, iteration: IIteration) => void
        • (row: SetValueType, index: number, iteration: IIteration): void

        • Parameters

          • row: SetValueType
          • index: number
          • iteration: IIteration

          Returns void

    Returns void

  • Type parameters

    • SetValueType

    • CbRetType

    Parameters

    • value: Set<SetValueType>
    • callback: (row: SetValueType, index: number, iteration: IIteration) => void | CbRetType
        • (row: SetValueType, index: number, iteration: IIteration): void | CbRetType

        • Parameters

          • row: SetValueType
          • index: number
          • iteration: IIteration

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • SetValueType

    • CbRetType

    Parameters

    • value: Set<SetValueType>
    • callback: (row: SetValueType, index: number, iteration: IIteration) => void | CbRetType
        • (row: SetValueType, index: number, iteration: IIteration): void | CbRetType

        • Parameters

          • row: SetValueType
          • index: number
          • iteration: IIteration

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

iterateChunk

  • iterateChunk<RowType>(size: number, val: Record<RecordIndexes, RowType>, cb: (rows: Record<RecordIndexes, RowType>, iter: IIteration) => void): Promise<void>
  • iterateChunk<RowType>(size: number, val: RowType[], cb: (rows: RowType[], idxs: RowType[], iter: IIteration) => void): Promise<void>

  • Type parameters

    • RowType

    Parameters

    • size: number
    • val: Record<RecordIndexes, RowType>
    • cb: (rows: Record<RecordIndexes, RowType>, iter: IIteration) => void
        • (rows: Record<RecordIndexes, RowType>, iter: IIteration): void

        • Parameters

          • rows: Record<RecordIndexes, RowType>
          • iter: IIteration

          Returns void

    Returns Promise<void>

  • Type parameters

    • RowType

    Parameters

    • size: number
    • val: RowType[]
    • cb: (rows: RowType[], idxs: RowType[], iter: IIteration) => void
        • (rows: RowType[], idxs: RowType[], iter: IIteration): void

        • Parameters

          Returns void

    Returns Promise<void>

iterateKeys

  • iterateKeys<ArrayType>(value: ArrayType[], callback: (index: number, row: ArrayType, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateKeys<ArrayType, CbRetType>(value: ArrayType[], callback: (index: number, row: ArrayType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterateKeys<ArrayType, CbRetType>(value: ArrayType[], callback: (index: number, row: ArrayType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterateKeys<ObjectType>(value: Record<RecordIndexes, ObjectType>, callback: (index: string, row: ObjectType, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateKeys<ObjectType, CbRetType>(value: Record<RecordIndexes, ObjectType>, callback: (index: string, row: ObjectType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterateKeys<ObjectType, CbRetType>(value: Record<RecordIndexes, ObjectType>, callback: (index: string, row: ObjectType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterateKeys(value: number, callback: (index: number, row: number, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateKeys<CbRetType>(value: number, callback: (index: number, row: number, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterateKeys<CbRetType>(value: number, callback: (index: number, row: number, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterateKeys<MapIndexType, MapValueType>(value: Map<MapIndexType, MapValueType>, callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateKeys<MapIndexType, MapValueType, CbRetType>(value: Map<MapIndexType, MapValueType>, callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterateKeys<MapIndexType, MapValueType, CbRetType>(value: Map<MapIndexType, MapValueType>, callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterateKeys<SetValueType>(value: Set<SetValueType>, callback: (index: number, row: SetValueType, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateKeys<SetValueType, CbRetType>(value: Set<SetValueType>, callback: (index: number, row: SetValueType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): Promise<CbRetType[]>
  • iterateKeys<SetValueType, CbRetType>(value: Set<SetValueType>, callback: (index: number, row: SetValueType, iteration: IIteration) => Promise<void | CbRetType>, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Promise<Record<RecordIndexes, CbRetType>>
  • iterateKeys<ArrayType>(value: ArrayType[], callback: (index: number, row: ArrayType, iteration: IIteration) => void): void
  • iterateKeys<ArrayType, CbRetType>(value: ArrayType[], callback: (index: number, row: ArrayType, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterateKeys<ArrayType, CbRetType>(value: ArrayType[], callback: (index: number, row: ArrayType, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>
  • iterateKeys<ObjectType>(value: Record<RecordIndexes, ObjectType>, callback: (index: string, row: ObjectType, iteration: IIteration) => void): void
  • iterateKeys<ObjectType, CbRetType>(value: Record<RecordIndexes, ObjectType>, callback: (index: string, row: ObjectType, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterateKeys<ObjectType, CbRetType>(value: Record<RecordIndexes, ObjectType>, callback: (index: string, row: ObjectType, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>
  • iterateKeys(value: number, callback: (index: number, row: number, iteration: IIteration) => void): void
  • iterateKeys<CbRetType>(value: number, callback: (index: number, row: number, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterateKeys<CbRetType>(value: number, callback: (index: number, row: number, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>
  • iterateKeys<MapIndexType, MapValueType>(value: Map<MapIndexType, MapValueType>, callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => void): void
  • iterateKeys<MapIndexType, MapValueType, CbRetType>(value: Map<MapIndexType, MapValueType>, callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterateKeys<MapIndexType, MapValueType, CbRetType>(value: Map<MapIndexType, MapValueType>, callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>
  • iterateKeys<SetValueType>(value: Set<SetValueType>, callback: (index: number, row: SetValueType, iteration: IIteration) => void): void
  • iterateKeys<SetValueType, CbRetType>(value: Set<SetValueType>, callback: (index: number, row: SetValueType, iteration: IIteration) => void | CbRetType, accumulate: CbRetType[], assign?: boolean, mapUndefined?: boolean): CbRetType[]
  • iterateKeys<SetValueType, CbRetType>(value: Set<SetValueType>, callback: (index: number, ow: SetValueType, iteration: IIteration) => void | CbRetType, accumulate: Record<RecordIndexes, CbRetType>, assign?: boolean, mapUndefined?: boolean): Record<RecordIndexes, CbRetType>

  • [[include: iterate-keys.md]]

    Type parameters

    • ArrayType

    Parameters

    • value: ArrayType[]
    • callback: (index: number, row: ArrayType, iteration: IIteration) => Promise<void>
        • (index: number, row: ArrayType, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • ArrayType

    • CbRetType

    Parameters

    • value: ArrayType[]
    • callback: (index: number, row: ArrayType, iteration: IIteration) => Promise<void | CbRetType>
        • (index: number, row: ArrayType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • ArrayType

    • CbRetType

    Parameters

    • value: ArrayType[]
    • callback: (index: number, row: ArrayType, iteration: IIteration) => Promise<void | CbRetType>
        • (index: number, row: ArrayType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Type parameters

    • ObjectType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (index: string, row: ObjectType, iteration: IIteration) => Promise<void>
        • (index: string, row: ObjectType, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • ObjectType

    • CbRetType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (index: string, row: ObjectType, iteration: IIteration) => Promise<void | CbRetType>
        • (index: string, row: ObjectType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • ObjectType

    • CbRetType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (index: string, row: ObjectType, iteration: IIteration) => Promise<void | CbRetType>
        • (index: string, row: ObjectType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Parameters

    • value: number
    • callback: (index: number, row: number, iteration: IIteration) => Promise<void>
        • (index: number, row: number, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • CbRetType

    Parameters

    • value: number
    • callback: (index: number, row: number, iteration: IIteration) => Promise<void | CbRetType>
        • (index: number, row: number, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • CbRetType

    Parameters

    • value: number
    • callback: (index: number, row: number, iteration: IIteration) => Promise<void | CbRetType>
        • (index: number, row: number, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Type parameters

    • MapIndexType

    • MapValueType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => Promise<void>
        • (index: MapIndexType, row: MapValueType, iteration: IIteration): Promise<void>

        • Parameters

          • index: MapIndexType
          • row: MapValueType
          • iteration: IIteration

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • MapIndexType

    • MapValueType

    • CbRetType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => Promise<void | CbRetType>
        • (index: MapIndexType, row: MapValueType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          • index: MapIndexType
          • row: MapValueType
          • iteration: IIteration

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • MapIndexType

    • MapValueType

    • CbRetType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => Promise<void | CbRetType>
        • (index: MapIndexType, row: MapValueType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          • index: MapIndexType
          • row: MapValueType
          • iteration: IIteration

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Type parameters

    • SetValueType

    Parameters

    • value: Set<SetValueType>
    • callback: (index: number, row: SetValueType, iteration: IIteration) => Promise<void>
        • (index: number, row: SetValueType, iteration: IIteration): Promise<void>

        • Parameters

          • index: number
          • row: SetValueType
          • iteration: IIteration

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • SetValueType

    • CbRetType

    Parameters

    • value: Set<SetValueType>
    • callback: (index: number, row: SetValueType, iteration: IIteration) => Promise<void | CbRetType>
        • (index: number, row: SetValueType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          • index: number
          • row: SetValueType
          • iteration: IIteration

          Returns Promise<void | CbRetType>

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<CbRetType[]>

  • Type parameters

    • SetValueType

    • CbRetType

    Parameters

    • value: Set<SetValueType>
    • callback: (index: number, row: SetValueType, iteration: IIteration) => Promise<void | CbRetType>
        • (index: number, row: SetValueType, iteration: IIteration): Promise<void | CbRetType>

        • Parameters

          • index: number
          • row: SetValueType
          • iteration: IIteration

          Returns Promise<void | CbRetType>

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Promise<Record<RecordIndexes, CbRetType>>

  • Type parameters

    • ArrayType

    Parameters

    • value: ArrayType[]
    • callback: (index: number, row: ArrayType, iteration: IIteration) => void
        • (index: number, row: ArrayType, iteration: IIteration): void

        • Parameters

          Returns void

    Returns void

  • Type parameters

    • ArrayType

    • CbRetType

    Parameters

    • value: ArrayType[]
    • callback: (index: number, row: ArrayType, iteration: IIteration) => void | CbRetType
        • (index: number, row: ArrayType, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • ArrayType

    • CbRetType

    Parameters

    • value: ArrayType[]
    • callback: (index: number, row: ArrayType, iteration: IIteration) => void | CbRetType
        • (index: number, row: ArrayType, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

  • Type parameters

    • ObjectType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (index: string, row: ObjectType, iteration: IIteration) => void
        • (index: string, row: ObjectType, iteration: IIteration): void

        • Parameters

          Returns void

    Returns void

  • Type parameters

    • ObjectType

    • CbRetType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (index: string, row: ObjectType, iteration: IIteration) => void | CbRetType
        • (index: string, row: ObjectType, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • ObjectType

    • CbRetType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (index: string, row: ObjectType, iteration: IIteration) => void | CbRetType
        • (index: string, row: ObjectType, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

  • Parameters

    • value: number
    • callback: (index: number, row: number, iteration: IIteration) => void
        • (index: number, row: number, iteration: IIteration): void

        • Parameters

          Returns void

    Returns void

  • Type parameters

    • CbRetType

    Parameters

    • value: number
    • callback: (index: number, row: number, iteration: IIteration) => void | CbRetType
        • (index: number, row: number, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • CbRetType

    Parameters

    • value: number
    • callback: (index: number, row: number, iteration: IIteration) => void | CbRetType
        • (index: number, row: number, iteration: IIteration): void | CbRetType

        • Parameters

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

  • Type parameters

    • MapIndexType

    • MapValueType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => void
        • (index: MapIndexType, row: MapValueType, iteration: IIteration): void

        • Parameters

          • index: MapIndexType
          • row: MapValueType
          • iteration: IIteration

          Returns void

    Returns void

  • Type parameters

    • MapIndexType

    • MapValueType

    • CbRetType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => void | CbRetType
        • (index: MapIndexType, row: MapValueType, iteration: IIteration): void | CbRetType

        • Parameters

          • index: MapIndexType
          • row: MapValueType
          • iteration: IIteration

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • MapIndexType

    • MapValueType

    • CbRetType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (index: MapIndexType, row: MapValueType, iteration: IIteration) => void | CbRetType
        • (index: MapIndexType, row: MapValueType, iteration: IIteration): void | CbRetType

        • Parameters

          • index: MapIndexType
          • row: MapValueType
          • iteration: IIteration

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

  • Type parameters

    • SetValueType

    Parameters

    • value: Set<SetValueType>
    • callback: (index: number, row: SetValueType, iteration: IIteration) => void
        • (index: number, row: SetValueType, iteration: IIteration): void

        • Parameters

          • index: number
          • row: SetValueType
          • iteration: IIteration

          Returns void

    Returns void

  • Type parameters

    • SetValueType

    • CbRetType

    Parameters

    • value: Set<SetValueType>
    • callback: (index: number, row: SetValueType, iteration: IIteration) => void | CbRetType
        • (index: number, row: SetValueType, iteration: IIteration): void | CbRetType

        • Parameters

          • index: number
          • row: SetValueType
          • iteration: IIteration

          Returns void | CbRetType

    • accumulate: CbRetType[]
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns CbRetType[]

  • Type parameters

    • SetValueType

    • CbRetType

    Parameters

    • value: Set<SetValueType>
    • callback: (index: number, ow: SetValueType, iteration: IIteration) => void | CbRetType
        • (index: number, ow: SetValueType, iteration: IIteration): void | CbRetType

        • Parameters

          • index: number
          • ow: SetValueType
          • iteration: IIteration

          Returns void | CbRetType

    • accumulate: Record<RecordIndexes, CbRetType>
    • Optional assign: boolean
    • Optional mapUndefined: boolean

    Returns Record<RecordIndexes, CbRetType>

iterateParallel

  • iterateParallel<ArrayType>(value: ArrayType[], callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateParallel<ObjectType>(value: Record<RecordIndexes, ObjectType>, callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateParallel<MapIndexType, MapValueType>(value: Map<MapIndexType, MapValueType>, callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateParallel<SetValueType>(value: Set<SetValueType>, callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void>): Promise<void>

  • [[include: iterate-parallel.md]]

    Type parameters

    • ArrayType

    Parameters

    • value: ArrayType[]
    • callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void>
        • (row: ArrayType, index: number, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • ObjectType

    Parameters

    • value: Record<RecordIndexes, ObjectType>
    • callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void>
        • (row: ObjectType, index: string, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • MapIndexType

    • MapValueType

    Parameters

    • value: Map<MapIndexType, MapValueType>
    • callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void>
        • (row: MapValueType, index: MapIndexType, iteration: IIteration): Promise<void>

        • Parameters

          • row: MapValueType
          • index: MapIndexType
          • iteration: IIteration

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • SetValueType

    Parameters

    • value: Set<SetValueType>
    • callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void>
        • (row: SetValueType, index: number, iteration: IIteration): Promise<void>

        • Parameters

          • row: SetValueType
          • index: number
          • iteration: IIteration

          Returns Promise<void>

    Returns Promise<void>

iterateParallelLimit

  • iterateParallelLimit<ArrayType>(limit: number, value: ArrayType[], callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateParallelLimit<ObjectType>(limit: number, value: Record<RecordIndexes, ObjectType>, callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateParallelLimit<MapIndexType, MapValueType>(limit: number, value: Map<MapIndexType, MapValueType>, callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void>): Promise<void>
  • iterateParallelLimit<SetValueType>(limit: number, value: Set<SetValueType>, callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void>): Promise<void>

  • Type parameters

    • ArrayType

    Parameters

    • limit: number
    • value: ArrayType[]
    • callback: (row: ArrayType, index: number, iteration: IIteration) => Promise<void>
        • (row: ArrayType, index: number, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • ObjectType

    Parameters

    • limit: number
    • value: Record<RecordIndexes, ObjectType>
    • callback: (row: ObjectType, index: string, iteration: IIteration) => Promise<void>
        • (row: ObjectType, index: string, iteration: IIteration): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • MapIndexType

    • MapValueType

    Parameters

    • limit: number
    • value: Map<MapIndexType, MapValueType>
    • callback: (row: MapValueType, index: MapIndexType, iteration: IIteration) => Promise<void>
        • (row: MapValueType, index: MapIndexType, iteration: IIteration): Promise<void>

        • Parameters

          • row: MapValueType
          • index: MapIndexType
          • iteration: IIteration

          Returns Promise<void>

    Returns Promise<void>

  • Type parameters

    • SetValueType

    Parameters

    • limit: number
    • value: Set<SetValueType>
    • callback: (row: SetValueType, index: number, iteration: IIteration) => Promise<void>
        • (row: SetValueType, index: number, iteration: IIteration): Promise<void>

        • Parameters

          • row: SetValueType
          • index: number
          • iteration: IIteration

          Returns Promise<void>

    Returns Promise<void>

mapToArray

  • mapToArray<T, K>(value: Map<T, K>): [T, K][]

  • Type parameters

    • T = any

    • K = any

    Parameters

    • value: Map<T, K>

    Returns [T, K][]

nop

  • nop(): void

  • Sync void empty function (No Operation)

    Returns void

nop$

  • nop$(): Promise<void>

  • Async void empty function (No Operation Async)

    Returns Promise<void>

objectToArray

  • objectToArray(value: object, toKeys?: boolean): any[]

  • [[include: object-to-TAnyArray.md]]

    Parameters

    • value: object
    • Optional toKeys: boolean

    Returns any[]

random

  • random(): number

  • Returns number

setDefaults

  • setDefaults(obj: {}, name: string | number, value?: any): object

  • [[include: set-defaults.md]]

    Parameters

    • obj: {}
      • [key: string]: any
    • name: string | number
    • Optional value: any

    Returns object

sortObject

  • sortObject<T>(target: T, onlyNumIdx?: boolean): T

  • Type parameters

    • T: {} = {}

    Parameters

    • target: T
    • Optional onlyNumIdx: boolean

    Returns T

toArray

  • toArray<T>(value: T | T[]): T[]

  • [[include: to-TAnyArray.md]]

    Type parameters

    • T = any

    Parameters

    • value: T | T[]

    Returns T[]

Generated using TypeDoc