Array Extensions

Array utility module

This module extends the native JavaScript Array prototype with additional utility methods.

Installation

npm install @sky-modules/core

Methods

last(): T

Returns the last element of the array.

Returns: The last element of the array, or undefined if the array is empty.

Example:

const numbers = [1, 2, 3, 4, 5]
console.log(numbers.last()) // 5

const empty: number[] = []
console.log(empty.last()) // undefined

remove(element: T): boolean

Removes the first occurrence of the specified element from the array.

Parameters:

• element: T - The element to remove from the array

Returns: true if the element was found and removed, false otherwise.

Example:

const fruits = ['apple', 'banana', 'apple', 'orange']
console.log(fruits.remove('banana')) // true
console.log(fruits) // ['apple', 'apple', 'orange']

console.log(fruits.remove('grape')) // false
console.log(fruits) // ['apple', 'apple', 'orange'] (unchanged)

shuffle(): this

Shuffles the array in place using the Fisher-Yates algorithm.

Returns: The same array instance (for method chaining).

Example:

const numbers = [1, 2, 3, 4, 5]
numbers.shuffle()
console.log(numbers) // [3, 1, 5, 2, 4] (random order)

toShuffled(): this

Creates a new shuffled copy of the array without modifying the original.

Returns: A new array with the same elements in random order.

Example:

const original = [1, 2, 3, 4, 5]
const shuffled = original.toShuffled()
console.log(original) // [1, 2, 3, 4, 5] (unchanged)
console.log(shuffled) // [3, 1, 5, 2, 4] (random order)

Type Safety

All methods are properly typed and work with generic arrays:

const strings: string[] = ['a', 'b', 'c']
const lastString: string = strings.last() // Type: string

const numbers: number[] = [1, 2, 3]
const removed: boolean = numbers.remove(2) // Type: boolean

Non-enumerable Properties

All added methods are marked as non-enumerable, meaning they won't appear when iterating over array properties or using Object.keys().

Usage

Import the global extensions to make the methods available on all arrays:

import '@sky-modules/core/Array/global'

Or import individual methods:

import '@sky-modules/core/Array/Array+last'
import '@sky-modules/core/Array/Array+remove'
import '@sky-modules/core/Array/Array+shuffle'
import '@sky-modules/core/Array/Array+toShuffled'