Options
All
  • Public
  • Public/Protected
  • All
Menu

@tsdotnet/array-utility - v1.0.25

Index

Functions

  • Is similar to Array.map() but instead of returning a new array, it updates the existing indexes. Can also be applied to a structure that indexes like an array, but may not be.

    Type parameters

    • T

    Parameters

    Returns void

  • Clears (sets to null) values of an array across a range of indexes.

    Parameters

    Returns void

  • contains<T>(array: ArrayLike<T>, item: T, equalityComparer?: EqualityComparison<T>): boolean
  • Checks to see if the provided array contains an item. If the array value is null, then false is returned.

    Type parameters

    • T

    Parameters

    • array: ArrayLike<T>
    • item: T
    • equalityComparer: EqualityComparison<T> = areEqual

    Returns boolean

  • distinct(source: null | string[]): string[]
  • distinct(source: null | number[]): number[]
  • Returns a unique reduced set of values.

    Parameters

    • source: null | string[]

    Returns string[]

  • Parameters

    • source: null | number[]

    Returns number[]

  • findIndex<T>(array: ArrayLike<T>, predicate: PredicateWithIndex<T>): number
  • Returns the first index of which the provided predicate returns true. Returns -1 if always false.

    Type parameters

    • T

    Parameters

    • array: ArrayLike<T>
    • predicate: PredicateWithIndex<T>

    Returns number

  • flatten(a: any[], recurseDepth?: number): any[]
  • Takes any arrays within an array and inserts the values contained within in place of that array. For every count higher than 0 in recurseDepth it will attempt an additional pass. Passing Infinity will flatten all arrays contained.

    Parameters

    • a: any[]
    • recurseDepth: number = 0

    Returns any[]

  • forEach<T>(source: ArrayLike<T>, action: ActionWithIndex<T> | PredicateWithIndex<T>): void
  • Allows for using "false" to cause forEach to break. Can also be applied to a structure that indexes like an array, but may not be.

    Type parameters

    • T

    Parameters

    • source: ArrayLike<T>
    • action: ActionWithIndex<T> | PredicateWithIndex<T>

    Returns void

  • indexOf<T>(array: ArrayLike<T>, item: T, equalityComparer?: EqualityComparison<T>): number
  • Checks to see where the provided array contains an item/value. If the array value is null, then -1 is returned.

    Type parameters

    • T

    Parameters

    • array: ArrayLike<T>
    • item: T
    • equalityComparer: EqualityComparison<T> = areEqual

    Returns number

  • range(first: number, count: number, step?: number): number[]
  • Returns a range of numbers based upon the first value and the step value.

    Parameters

    • first: number
    • count: number
    • step: number = 1

    Returns number[]

  • rangeUntil(first: number, until: number, step?: number): number[]
  • Returns a range of numbers based upon the first value and the step value excluding any numbers at or beyond the until value.

    Parameters

    • first: number
    • until: number
    • step: number = 1

    Returns number[]

  • register<T>(array: ArrayLikeWritable<T>, item: T, equalityComparer?: EqualityComparison<T>): boolean
  • Ensures a value exists within an array. If not found, adds to the end.

    Type parameters

    • T

    Parameters

    Returns boolean

  • remove<T>(array: T[], value: T, max?: number, equalityComparer?: EqualityComparison<T>): number
  • Finds and removes a value from an array. Will remove all instances unless a maximum is specified.

    Type parameters

    • T

    Parameters

    • array: T[]
    • value: T
    • max: number = Infinity
    • equalityComparer: EqualityComparison<T> = areEqual

    Returns number

    The number of times the value was found and removed.

  • removeIndex<T>(array: T[], index: number): boolean
  • Removes an entry at a specified index.

    Type parameters

    • T

    Parameters

    • array: T[]
    • index: number

    Returns boolean

    True if the value was able to be removed.

  • repeat<T>(element: T, count: number): T[]
  • Simply repeats a value the number of times specified.

    Type parameters

    • T

    Parameters

    • element: T
    • count: number

    Returns T[]

  • Finds and replaces a value from an array. Will replaces all instances unless a maximum is specified.

    Type parameters

    • T

    Parameters

    Returns number

  • updateRange<T>(array: ArrayLike<T>, value: T, start?: number, stop?: number): void
  • Replaces values of an array across a range of indexes.

    Type parameters

    • T

    Parameters

    • array: ArrayLike<T>
    • value: T
    • start: number = 0
    • Optional stop: number

    Returns void

Generated using TypeDoc