Class ArrayUtils

Index

Constructors

constructor

Methods

combine difference findNearest getUnique sortByField sortByNumberField sortByStringField splitByValue

Constructors

constructor

new ArrayUtils(): ArrayUtils
Returns ArrayUtils

Methods

combine

combine<X, Y, T>(xs: X[], ys: Y[], combineFunction: (x: X, y: Y) => T): T[]
Creates all possible permutations of elements in first array and second. Elements within same array are not permutated.
Type Parameters
- X
- Y
- T
Parameters
- xs: X[]
- ys: Y[]
- combineFunction: (x: X, y: Y) => T
Returns T[]
- Defined in ArrayUtils/index.ts:14

difference

difference<T>(xs: T[], ys: T[], getValue: Fn<T, string | number>): T[]
Finds all values that are in xs but not in ys
Type Parameters
- T
Parameters
- xs: T[]
- ys: T[]
- getValue: Fn<T, string | number>
Returns T[]
- Defined in ArrayUtils/index.ts:27

findNearest

findNearest(value: number, candidates: number[]): number
Picks number in array nearest value
Parameters
- value: number
- candidates: number[]
Returns number
- Defined in ArrayUtils/index.ts:34

getUnique

getUnique<T>(values: T[]): T[]
Removes duplicate values from an array.
Type Parameters
- T
Parameters
- values: T[]
  The array to deduplicate.
Returns T[]
A new array with unique values.
- Defined in ArrayUtils/index.ts:186

sortByField

sortByField<T extends object>(
    data: T[],
    getValue: Fn<T, string> | Fn<T, number> | Fn<T, Date>,
    direction?: Direction,
): T[]
Sorts an object array by a field
Type Parameters
- T extends object
Parameters
- data: T[]
- getValue: Fn<T, string> | Fn<T, number> | Fn<T, Date>
- direction: Direction = "ASC"
Returns T[]
- Defined in ArrayUtils/index.ts:147

sortByNumberField

sortByNumberField<T extends object>(
    data: T[],
    getValue: Fn<T, number>,
    direction?: Direction,
): T[]
Sorts an array of objects by a numeric field.
Type Parameters
- T extends object
Parameters
- data: T[]
  The array of objects to sort.
- getValue: Fn<T, number>
  Function to extract the numeric value from each object.
- direction: Direction = "ASC"
  Sort direction, either "ASC" or "DESC" (default: "ASC").
Returns T[]
A new sorted array.
- Defined in ArrayUtils/index.ts:78

sortByStringField

sortByStringField<T extends object>(
    data: T[],
    getValue: Fn<T, string>,
    direction?: Direction,
): T[]
Sorts an array of objects by a string field.
Type Parameters
- T extends object
Parameters
- data: T[]
  The array of objects to sort.
- getValue: Fn<T, string>
  Function to extract the string value from each object.
- direction: Direction = "ASC"
  Sort direction, either "ASC" or "DESC" (default: "ASC").
Returns T[]
A new sorted array.
- Defined in ArrayUtils/index.ts:118

splitByValue

splitByValue<T>(
    array: T[],
    value: T,
    predicate: (a: T, b: T) => boolean,
): [T[], T[]]
Splits array into array of elements before value and elements after it. If value is not found in array, all of array is return as elements before.
Type Parameters
- T
Parameters
- array: T[]
- value: T
- predicate: (a: T, b: T) => boolean
Returns [T[], T[]]
- Defined in ArrayUtils/index.ts:56

Class ArrayUtils

Index

Constructors

Methods

Constructors

constructor

Returns ArrayUtils

Methods

combine

Type Parameters

Parameters

Returns T[]

difference

Type Parameters

Parameters

Returns T[]

findNearest

Parameters

Returns number

getUnique

Type Parameters

Parameters

Returns T[]

sortByField

Type Parameters

Parameters

Returns T[]

sortByNumberField

Type Parameters

Parameters

Returns T[]

sortByStringField

Type Parameters

Parameters

Returns T[]

splitByValue

Type Parameters

Parameters

Returns [T[], T[]]

Settings

On This Page