Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace nTools

Variables

Functions

Variables

Const asyncFunctionPattern

asyncFunctionPattern: string

Const default

default: object

Type declaration

  • GUID: typeof GUID
  • UID: typeof UID
  • arrayToObject: typeof arrayToObject
  • asyncFunctionPattern: string
  • delay: typeof delay
  • escapeRegExp: typeof escapeRegExp
  • isArray: typeof isArray
  • isAsyncFunction: typeof isAsyncFunction
  • isBoolean: typeof isBoolean
  • isEmptyArray: typeof isEmptyArray
  • isEmptyObject: typeof isEmptyObject
  • isFloat: typeof isFloat
  • isFunction: typeof isFunction
  • isGUID: typeof isGUID
  • isGUIDv4: typeof isGUIDv4
  • isInteger: typeof isInteger
  • isIterable: typeof isIterable
  • isJSON: typeof isJSON
  • isNativeObject: typeof isNativeObject
  • isNull: typeof isNull
  • isNumber: typeof isNumber
  • isObject: typeof isObject
  • isPositiveInteger: typeof isPositiveInteger
  • isRegExp: typeof isRegExp
  • isString: typeof isString
  • isSymbol: typeof isSymbol
  • isUndefined: typeof isUndefined
  • iterate: typeof iterate
  • iterateKeys: typeof iterateKeys
  • iterateParallel: typeof iterateParallel
  • iterateParallelLimit: typeof iterateParallelLimit
  • nop: typeof nop
  • nop$: typeof nop$
  • objectToArray: typeof objectToArray
  • setDefaults: typeof setDefaults
  • toArray: typeof toArray

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: types.TAnyArray, toKeys?: boolean | false): types.TAnyObject

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

    Parameters

    • value: types.TAnyArray
    • Optional toKeys: boolean | false

    Returns types.TAnyObject

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

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

isString

  • isString(value: any): boolean

  • Is value a string

    Parameters

    • value: any

    Returns boolean

isSymbol

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

  • Is value symbol

    Parameters

    • value: any
    • Optional name: boolean | string

    Returns boolean

isUndefined

  • isUndefined(value: any): boolean

  • Is value an undefined

    Parameters

    • value: any

    Returns boolean

iterate

  • iterate<T, U>(value: T[], callback: function, accumulate?: types.TAccumulate, assign?: types.TAssign): types.TIterateResult
  • iterate<T, U>(value: object, callback: function, accumulate?: types.TAccumulate, assign?: types.TAssign): types.TIterateResult
  • iterate<U>(value: string, callback: function, accumulate?: types.TAccumulate, assign?: types.TAssign): types.TIterateResult
  • iterate<U>(value: number, callback: function, accumulate?: types.TAccumulate, assign?: types.TAssign): types.TIterateResult

  • [[include: iterate.md]]

    Type parameters

    • T

    • U

    Parameters

    • value: T[]
    • callback: function
        • (row: T, index: number, iteration: IIteration): U

        • Parameters

          • row: T
          • index: number
          • iteration: IIteration

          Returns U

    • Optional accumulate: types.TAccumulate
    • Optional assign: types.TAssign

    Returns types.TIterateResult

  • Type parameters

    • T: Object

    • U

    Parameters

    • value: object
      • [key: string]: T
    • callback: function
        • (row: T, index: string, iteration: IIteration): U

        • Parameters

          • row: T
          • index: string
          • iteration: IIteration

          Returns U

    • Optional accumulate: types.TAccumulate
    • Optional assign: types.TAssign

    Returns types.TIterateResult

  • Type parameters

    • U

    Parameters

    • value: string
    • callback: function
        • (row: string, index: number, iteration: IIteration): U

        • Parameters

          • row: string
          • index: number
          • iteration: IIteration

          Returns U

    • Optional accumulate: types.TAccumulate
    • Optional assign: types.TAssign

    Returns types.TIterateResult

  • Type parameters

    • U

    Parameters

    • value: number
    • callback: function
        • (row: number, index: number, iteration: IIteration): U

        • Parameters

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

          Returns U

    • Optional accumulate: types.TAccumulate
    • Optional assign: types.TAssign

    Returns types.TIterateResult

iterateKeys

  • iterateKeys<T, U>(value: T[], callback: function, accumulate?: types.TAccumulate, assign?: types.TAssign): types.TIterateResult
  • iterateKeys<T, U>(value: object, callback: function, accumulate?: types.TAccumulate, assign?: types.TAssign): types.TIterateResult
  • iterateKeys<U>(value: string, callback: function, accumulate?: types.TAccumulate, assign?: types.TAssign): types.TIterateResult
  • iterateKeys<U>(value: number, callback: function, accumulate?: types.TAccumulate, assign?: types.TAssign): types.TIterateResult

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

    Type parameters

    • T

    • U

    Parameters

    • value: T[]
    • callback: function
        • (index: number, row: T, iteration: IIteration): U

        • Parameters

          • index: number
          • row: T
          • iteration: IIteration

          Returns U

    • Optional accumulate: types.TAccumulate
    • Optional assign: types.TAssign

    Returns types.TIterateResult

  • Type parameters

    • T: Object

    • U

    Parameters

    • value: object
      • [key: string]: T
    • callback: function
        • (index: string, row: T, iteration: IIteration): U

        • Parameters

          • index: string
          • row: T
          • iteration: IIteration

          Returns U

    • Optional accumulate: types.TAccumulate
    • Optional assign: types.TAssign

    Returns types.TIterateResult

  • Type parameters

    • U

    Parameters

    • value: string
    • callback: function
        • (index: number, row: string, iteration: IIteration): U

        • Parameters

          • index: number
          • row: string
          • iteration: IIteration

          Returns U

    • Optional accumulate: types.TAccumulate
    • Optional assign: types.TAssign

    Returns types.TIterateResult

  • Type parameters

    • U

    Parameters

    • value: number
    • callback: function
        • (index: number, row: number, iteration: IIteration): U

        • Parameters

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

          Returns U

    • Optional accumulate: types.TAccumulate
    • Optional assign: types.TAssign

    Returns types.TIterateResult

iterateParallel

  • iterateParallel<T, U>(value: T[], callback: function): types.TIteratePromiseResult
  • iterateParallel<T, U>(value: object, callback: function): types.TIteratePromiseResult
  • iterateParallel<U>(value: string, callback: function): types.TIteratePromiseResult
  • iterateParallel<U>(value: number, callback: function): types.TIteratePromiseResult

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

    Type parameters

    • T

    • U

    Parameters

    • value: T[]
    • callback: function
        • (row: T, index: number, iteration: IIteration): U

        • Parameters

          • row: T
          • index: number
          • iteration: IIteration

          Returns U

    Returns types.TIteratePromiseResult

  • Type parameters

    • T: Object

    • U

    Parameters

    • value: object
      • [key: string]: T
    • callback: function
        • (row: T, index: string, iteration: IIteration): U

        • Parameters

          • row: T
          • index: string
          • iteration: IIteration

          Returns U

    Returns types.TIteratePromiseResult

  • Type parameters

    • U

    Parameters

    • value: string
    • callback: function
        • (row: string, index: number, iteration: IIteration): U

        • Parameters

          • row: string
          • index: number
          • iteration: IIteration

          Returns U

    Returns types.TIteratePromiseResult

  • Type parameters

    • U

    Parameters

    • value: number
    • callback: function
        • (row: number, index: number, iteration: IIteration): U

        • Parameters

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

          Returns U

    Returns types.TIteratePromiseResult

iterateParallelLimit

  • iterateParallelLimit<T, U>(limit: number, value: T[], callback: function): types.TIteratePromiseResult
  • iterateParallelLimit<T, U>(limit: number, value: object, callback: function): types.TIteratePromiseResult
  • iterateParallelLimit<U>(limit: number, value: string, callback: function): types.TIteratePromiseResult
  • iterateParallelLimit<U>(limit: number, value: number, callback: function): types.TIteratePromiseResult

  • Type parameters

    • T

    • U

    Parameters

    • limit: number
    • value: T[]
    • callback: function
        • (row: T, index: number, iteration: IIteration): U

        • Parameters

          • row: T
          • index: number
          • iteration: IIteration

          Returns U

    Returns types.TIteratePromiseResult

  • Type parameters

    • T: Object

    • U

    Parameters

    • limit: number
    • value: object
      • [key: string]: T
    • callback: function
        • (row: T, index: string, iteration: IIteration): U

        • Parameters

          • row: T
          • index: string
          • iteration: IIteration

          Returns U

    Returns types.TIteratePromiseResult

  • Type parameters

    • U

    Parameters

    • limit: number
    • value: string
    • callback: function
        • (row: string, index: number, iteration: IIteration): U

        • Parameters

          • row: string
          • index: number
          • iteration: IIteration

          Returns U

    Returns types.TIteratePromiseResult

  • Type parameters

    • U

    Parameters

    • limit: number
    • value: number
    • callback: function
        • (row: number, index: number, iteration: IIteration): U

        • Parameters

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

          Returns U

    Returns types.TIteratePromiseResult

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 | false): any[]

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

    Parameters

    • value: object
    • Optional toKeys: boolean | false

    Returns any[]

setDefaults

  • setDefaults(obj: types.TAnyObject, name: types.TStringOrNumber, value?: any): object

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

    Parameters

    • obj: types.TAnyObject
    • name: types.TStringOrNumber
    • Optional value: any

    Returns object

toArray

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

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

    Type parameters

    • T

    Parameters

    • value: T | T[]

    Returns T[]

Generated using TypeDoc