nth
arrays
Gets the element at index n of array. If n is negative, the nth element from the end is returned.
Installation
Import
import { nth } from '@tulx/utils';Source Code
Implementation
/**
* Gets the element at index n of array. If n is negative, the nth element from the end is returned.
*
* @param array - The array to query.
* @param n - The index of the element to return.
* @returns The nth element of array.
*
* @example
* ```ts
* const array = ['a', 'b', 'c', 'd'];
* nth(array, 1); // 'b'
* nth(array, -2); // 'c'
* ```
*/
export function nth<T>(array: readonly T[], n: number): T | undefined {
const index = n < 0 ? array.length + n : n;
return index >= 0 && index < array.length ? array[index] : undefined;
}
Example
import { nth } from '@tulx/utils';
const array = ['a', 'b', 'c', 'd'];
nth(array, 1); // 'b'
nth(array, -2); // 'c'Related Functions
chunk
Creates an array of elements split into groups the length of size. If array can't be split evenly, the final chunk will be the remaining elements.
compact
Creates an array with all falsy values removed. The values false, null, 0, "", undefined, and NaN are falsy.
concat
Creates a new array concatenating array with any additional arrays and/or values.
difference
Creates an array of array values not included in the other given arrays. The order and references of result values are determined by the first array.
differenceBy
This method is like difference except that it accepts iteratee which is invoked for each element of array and values to generate the criterion by which they're compared.
differenceWith
This method is like difference except that it accepts comparator which is invoked to compare elements of array to values.