Options
All
  • Public
  • Public/Protected
  • All
Menu

A drop-in array replacement.

export

Type parameters

  • T: any

    The elements contained in this List

Hierarchy

  • Array<T>
    • List

Index

Constructors

constructor

  • new List<T>(...args: T[]): List<T>
  • Type parameters

    • T: unknown

    Parameters

    • Rest ...args: T[]

    Returns List<T>

Properties

Readonly [Symbol.species]

[Symbol.species]: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

[Symbol.toStringTag]

  • get [Symbol.toStringTag](): "List"

first

  • get first(): T
  • The first element of the List, or undefined if the length is 0.

    Returns T

last

  • get last(): T
  • The last element of the List, or undefined if the length is 0.

    Returns T

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<T>
  • Iterator

    Returns IterableIterator<T>

[Symbol.unscopables]

  • [Symbol.unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

clone

concat

  • concat(...items: ConcatArray<T>[]): List<T>
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<T>[]

      Additional items to add to the end of array1.

    Returns List<T>

copyWithin

  • copyWithin(target: number, start: number, end?: number): List<T>
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns List<T>

entries

  • entries(): IterableIterator<[number, T]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, T]>

even

every

  • every(predicate: (value: T, index: number, array: List<T>) => unknown, thisArg?: any): boolean
  • Determines whether none the members of an array satisfy the specified test.

    Parameters

    • predicate: (value: T, index: number, array: List<T>) => unknown

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        • (value: T, index: number, array: List<T>): unknown
        • Parameters

          • value: T
          • index: number
          • array: List<T>

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: T, start?: number, end?: number): List<T>
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: T

      value to fill array section with

    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns List<T>

filter

  • filter(predicate: (value: T, index: number, array: List<T>) => unknown, thisArg?: any): List<T>
  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • predicate: (value: T, index: number, array: List<T>) => unknown

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

        • (value: T, index: number, array: List<T>): unknown
        • Parameters

          • value: T
          • index: number
          • array: List<T>

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns List<T>

find

  • find<S>(predicate: (value: T, index: number, obj: T[]) => value is S, thisArg?: any): S
  • find(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: unknown

    Parameters

    • predicate: (value: T, index: number, obj: T[]) => value is S

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (value: T, index: number, obj: T[]): value is S
        • Parameters

          • value: T
          • index: number
          • obj: T[]

          Returns value is S

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S

  • Parameters

    • predicate: (value: T, index: number, obj: T[]) => unknown
        • (value: T, index: number, obj: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • obj: T[]

          Returns unknown

    • Optional thisArg: any

    Returns T

findIndex

  • findIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (value: T, index: number, obj: T[]) => unknown

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: T, index: number, obj: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • obj: T[]

          Returns unknown

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

flatten

  • flatten<U>(depth?: number): List<U>
  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • U: unknown

    Parameters

    • depth: number = 1

      The maximum recursion depth

    Returns List<U>

forEach

  • forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: (value: T, index: number, array: T[]) => void

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: T[]): void
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

get

  • get(index: number): T
  • Gets an element at the specified index. If the index is below 0, it returns the element starting from the end.

    Parameters

    • index: number

      The index of the element to get.

    Returns T

includes

  • includes(searchElement: T, fromIndex?: number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: T

      The element to search for.

    • Optional fromIndex: number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: T, fromIndex?: number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

isArray

  • isArray(arg: any): arg is any[]
  • Parameters

    • arg: any

    Returns arg is any[]

join

  • join(separator?: string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: T, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: (value: T, index: number, array: List<T>) => U, thisArg?: any): List<U>
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: (value: T, index: number, array: List<T>) => U

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: List<T>): U
        • Parameters

          • value: T
          • index: number
          • array: List<T>

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns List<U>

none

  • none(predicate: (value: T, index: number, array: List<T>) => unknown, thisArg?: any): boolean
  • Determines whether none the members of an array satisfy the specified test.

    Parameters

    • predicate: (value: T, index: number, array: List<T>) => unknown

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        • (value: T, index: number, array: List<T>): unknown
        • Parameters

          • value: T
          • index: number
          • array: List<T>

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

odd

of

  • of<T>(...items: T[]): T[]
  • Returns a new array from a set of elements.

    Type parameters

    • T

    Parameters

    • Rest ...items: T[]

      A set of elements to include in the new array object.

    Returns T[]

pop

  • pop(): T
  • Removes the last element from an array and returns it.

    Returns T

push

  • push(...items: T[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: T[]

      New elements of the Array.

    Returns number

pushArray

  • pushArray(array: T[]): List<T>
  • Concatenates an array.

    deprecated

    Switch to List#concat

    Parameters

    • array: T[]

      The array to concatenate

    Returns List<T>

random

  • random(count: 1, unique?: boolean): T
  • random(count?: number, unique?: boolean): T[]
  • Returns one or more random elements from this List.

    Parameters

    • count: 1

      The number of random elements to return (randomized).

    • Optional unique: boolean

      Whether the elements should be unique.

    Returns T

  • Parameters

    • Optional count: number
    • Optional unique: boolean

    Returns T[]

reduce

  • reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: List<T>) => T): T
  • reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: List<T>) => T, initialValue: T): T
  • reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: List<T>) => U, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: List<T>) => T

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: T, currentValue: T, currentIndex: number, array: List<T>): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: List<T>

          Returns T

    Returns T

  • Parameters

    • callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: List<T>) => T
        • (previousValue: T, currentValue: T, currentIndex: number, array: List<T>): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: List<T>

          Returns T

    • initialValue: T

    Returns T

  • Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: List<T>) => U
        • (previousValue: U, currentValue: T, currentIndex: number, array: List<T>): U
        • Parameters

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: List<T>

          Returns U

    • initialValue: U

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: List<T>) => T): T
  • reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: List<T>) => T, initialValue: T): T
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: List<T>) => U, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: List<T>) => T

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: T, currentValue: T, currentIndex: number, array: List<T>): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: List<T>

          Returns T

    Returns T

  • Parameters

    • callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: List<T>) => T
        • (previousValue: T, currentValue: T, currentIndex: number, array: List<T>): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: List<T>

          Returns T

    • initialValue: T

    Returns T

  • Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: List<T>) => U
        • (previousValue: U, currentValue: T, currentIndex: number, array: List<T>): U
        • Parameters

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: List<T>

          Returns U

    • initialValue: U

    Returns U

reverse

  • reverse(): T[]
  • Reverses the elements in an Array.

    Returns T[]

set

  • set(index: number, value: T): T
  • Sets an element at the specified index. If the index is below 0, it returns the element starting from the end. If you want to set a specific negative index, it's better to use subscript notation (array[index] = value;). If the index is out of bounds, (that is, if Math.abs(index) is outside the range 0-this.length) the element won't be recognized by the looping methods (forEach, map, reduce etc.)

    Parameters

    • index: number

      The index of the element to set.

    • value: T

    Returns T

shift

  • shift(): T
  • Removes the first element from an array and returns it.

    Returns T

shuffle

  • shuffle(copy?: false): List<T>
  • shuffle(copy: true): List<T>
  • Shuffles the list using the Durstenfeld algorithm.

    Parameters

    • Optional copy: false

      Whether to copy the List or shuffle in-place.

    Returns List<T>

  • Parameters

    • copy: true

    Returns List<T>

slice

  • slice(start?: number, end?: number): List<T>
  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

    Returns List<T>

some

  • some(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: (value: T, index: number, array: T[]) => unknown

      A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

        • (value: T, index: number, array: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: (a: T, b: T) => number): List<T>
  • Sorts an array.

    Parameters

    • Optional compareFn: (a: T, b: T) => number

      Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      [11,2,22,1].sort((a, b) => a - b)
      
        • (a: T, b: T): number
        • Parameters

          • a: T
          • b: T

          Returns number

    Returns List<T>

splice

  • splice(start: number, deleteCount?: number): List<T>
  • splice(start: number, deleteCount: number, ...items: List<T>): List<T>
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: number

      The number of elements to remove.

    Returns List<T>

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: List<T>

      Elements to insert into the array in place of the deleted elements.

    Returns List<T>

toArray

  • toArray(): T[]
  • Returns a JavaScript Array with the elements of this List.

    Returns T[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toObject

  • toObject(): ArrayLike<T>
  • Returns an Array-like object. Keep in mind that if you set a custom property through set(), it'll be lost.

    Returns ArrayLike<T>

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unique

unshift

  • unshift(...items: T[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: T[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<T>
  • Returns an iterable of values in the array

    Returns IterableIterator<T>

Static from

  • from<T>(arr: ArrayLike<T>): List<T>
  • Generates a new List from the Array-like object/iterable. Follows the semantics of Array.from.

    Type parameters

    • T

    Parameters

    • arr: ArrayLike<T>

      The array or List from which to generate this List.

    Returns List<T>

Static fromArray

  • fromArray<T>(arr?: T[]): List<T>
  • Generates a new List from the Array.

    Type parameters

    • T

    Parameters

    • arr: T[] = ...

      The array or List from which to generate this List.

    Returns List<T>

Static isList

  • isList<T>(candidate: {} | T): candidate is T extends Readonly<List<any>> ? unknown extends T ? never : Readonly<List<any>> : List<any>
  • Checks whether candidate is a List.

    Type parameters

    • T

    Parameters

    • candidate: {} | T

      The object to check

    Returns candidate is T extends Readonly<List<any>> ? unknown extends T ? never : Readonly<List<any>> : List<any>

Static range

  • range(max: number, inclusive?: boolean): List<number>
  • range(min: number, max: number, inclusive?: boolean): List<number>
  • Parameters

    • max: number
    • Optional inclusive: boolean

    Returns List<number>

  • Parameters

    • min: number
    • max: number
    • Optional inclusive: boolean

    Returns List<number>

Legend

  • Method
  • Static method

Generated using TypeDoc