Options
All
  • Public
  • Public/Protected
  • All
Menu

Module common/ArrayUtils

Index

Functions

Functions

Const arrayEquals

  • arrayEquals(a: any[], b: any[]): boolean

Const arrayEqualsPreserveOrder

  • arrayEqualsPreserveOrder(a: any[], b: any[]): boolean

Const keysInclude

  • keysInclude(obj: any, keys: any): boolean

  • Array agnostic version of objectKeysInclude.

    Checks if the keys of an object are a superset of a list, or if the object is an array, it checks the first 5 items.

    example
    keysInclude({name:'Sam'}, ['name']) // true
    keysInclude([{age:30}, {age:31, name: 'Sam'}], ['age']) // true

    Parameters

    • obj: any

      the object/array to check.

    • keys: any

      the list of keys each object must include. string array.

    Returns boolean

Const objectDepth

  • objectDepth(obj: any, maxDepthReached?: number): number

  • Calculates the maximum depth of an object by traversing every path. Can be expensive on large objects, so use sparingly.

    Parameters

    • obj: any

      the object to calculate depth of

    • maxDepthReached: number = 0

      a starting value, used for recursion. not recommended

    Returns number

Const objectKeysEqual

  • objectKeysEqual(a: Record<string, unknown>, b: string[]): boolean

Const objectKeysInclude

  • objectKeysInclude(a: Record<string, unknown>, b?: string[]): boolean

  • Checks if an object has at least all the specific keys. Could have more.

    Parameters

    • a: Record<string, unknown>

      the object to check the keys of.

    • Optional b: string[]

      the list of keys the object must include. string array.

    Returns boolean

    if the object has all the keys in the array.

Const objectOrArrayDepth

  • objectOrArrayDepth(obj: any): number

  • Get the depth of an object, or if its an array then the depth of the items.

    Parameters

    • obj: any

      the object or array to get depth of.

    Returns number

Const objectSize

  • objectSize(object: any): any

Const range

  • range(start: number, finish?: number, increment?: number): number[]

  • If start === finish, it starts at zero up to finish.

    example
    range(10) // 0 - 10
    range(1,5) // 1 - 5
    range(0,10,2) // 0,2,4,6,8,10

    Parameters

    • start: number
    • finish: number = start
    • increment: number = 1

    Returns number[]

Const repeat

  • repeat<T>(qty: number, mapFn: (index: number) => T): T[]

  • Type parameters

    • T = any

    Parameters

    • qty: number
    • mapFn: (index: number) => T
        • (index: number): T

        • Parameters

          • index: number

          Returns T

    Returns T[]

Generated using TypeDoc