@robbiemu/handy-typescript

@robbiemu/handy-typescript / Modules / List

Class: List<T>

Description

helper methods on Arrays, without polluting the Array object

Type parameters

Name
T

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new List<T>(arrayLength?)

Type parameters

Name
T

Parameters

Name Type
arrayLength? number

Inherited from

Array.constructor

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1485

Properties

length

• length: number

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

Inherited from

Array.length

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1304

[species]

▪ Static Readonly [species]: ArrayConstructor

Inherited from

Array.__@species@602

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:314

Accessors

first

• get first(): T

Property

Accessor

Description

first element in the list

Returns

T

Defined in

src/utility/list.ts:40

isEmpty

• get isEmpty(): boolean

Returns

boolean

Defined in

src/utility/list.ts:24

last

• get last(): T

Property

Accessor

Description

last element in the list

Returns

T

Defined in

src/utility/list.ts:32

Methods

[iterator]

▸ [iterator](): IterableIterator<any>

Iterator

Returns

IterableIterator<any>

Inherited from

Array.__@iterator@83

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:60

[unscopables]

▸ [unscopables](): Object

Returns an object whose properties have the value ‘true’ when they will be absent when used in a ‘with’ statement.

Returns

Object

Name Type
copyWithin boolean
entries boolean
fill boolean
find boolean
findIndex boolean
keys boolean
values boolean

Inherited from

Array.__@unscopables@85

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:99

aperture

▸ aperture(n): List<List<T>>

Method

aperture

Description

Returns a new list, composed of n-tuples of consecutive elements. Note: inspired by, and perhaps copied from Ramda

Parameters

Name Type Description
n number number of elements to group by

Returns

List<List<T>>

list of lists of (up to) n elements

Defined in

src/utility/list.ts:50

at

▸ at(index): any

Returns the item located at the specified index.

Parameters

Name Type Description
index number The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

any

Inherited from

Array.at

Defined in

node_modules/typescript/lib/lib.es2022.array.d.ts:26

between

▸ between(start, end): List<T>

Method

between

Description

return a subset of elements by their sort ordering. Note: can be used in two forms: list.between(start, end) and list.between(start).and(end)

Parameters

Name Type Description
start T the start of the range
end T the end of the range

Returns

List<T>

elements in the list

Defined in

src/utility/list.ts:134

concat

▸ concat(...items): any[]

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

Name Type Description
...items ConcatArray<any>[] Additional arrays and/or items to add to the end of the array.

Returns

any[]

Inherited from

Array.concat

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1328

▸ concat(...items): any[]

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

Name Type Description
...items any[] Additional arrays and/or items to add to the end of the array.

Returns

any[]

Inherited from

Array.concat

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1334

copyWithin

▸ copyWithin(target, start, end?): 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

Name Type Description
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.
end? number If not specified, length of the this object is used as its default value.

Returns

List<T>

Inherited from

Array.copyWithin

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:64

count

▸ count(): Map<T, number>

Method

count

Returns

Map<T, number>

a map of elements to the tally of their occurance

Defined in

src/utility/list.ts:123

entries

▸ entries(): IterableIterator<[number, any]>

Returns an iterable of key, value pairs for every entry in the array

Returns

IterableIterator<[number, any]>

Inherited from

Array.entries

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:65

every

▸ every<S>(predicate, thisArg?): this is S[]

Determines whether all the members of an array satisfy the specified test.

Type parameters

Name Type
S extends any

Parameters

Name Type Description
predicate (value: any, index: number, array: any[]) => value is S 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.
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

this is S[]

Inherited from

Array.every

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1411

▸ every(predicate, thisArg?): boolean

Determines whether all the members of an array satisfy the specified test.

Parameters

Name Type Description
predicate (value: any, index: number, array: any[]) => 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.
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

Inherited from

Array.every

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1420

fill

▸ fill(value, start?, end?): List<T>

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

Name Type Description
value any value to fill array section with
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.
end? number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

List<T>

Inherited from

Array.fill

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:53

filter

▸ filter<T>(lambda): List<T>

Type parameters

Name
T

Parameters

Name Type
lambda Comparator<T>

Returns

List<T>

Overrides

Array.filter

Defined in

src/utility/list.ts:16

find

▸ find<S>(predicate, thisArg?): S

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters

Name Type
S extends any

Parameters

Name Type Description
predicate (this: void, value: any, index: number, obj: any[]) => 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.
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

Inherited from

Array.find

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:31

▸ find(predicate, thisArg?): any

Parameters

Name Type
predicate (value: any, index: number, obj: any[]) => unknown
thisArg? any

Returns

any

Inherited from

Array.find

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:32

findIndex

▸ findIndex(predicate, thisArg?): number

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

Name Type Description
predicate (value: any, index: number, obj: any[]) => 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.
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

Inherited from

Array.findIndex

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:43

flat

▸ flat<A, D>(this, depth?): FlatArray<A, D>[]

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters

Name Type
A A
D extends number = 1

Parameters

Name Type Description
this A -
depth? D The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Array.flat

Defined in

node_modules/typescript/lib/lib.es2019.array.d.ts:81

flatMap

▸ flatMap<U, This>(callback, thisArg?): U[]

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters

Name Type
U U
This undefined

Parameters

Name Type Description
callback (this: This, value: any, index: number, array: any[]) => U | readonly U[] A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
thisArg? This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Array.flatMap

Defined in

node_modules/typescript/lib/lib.es2019.array.d.ts:70

forEach

▸ forEach(callbackfn, thisArg?): void

Performs the specified action for each element in an array.

Parameters

Name Type Description
callbackfn (value: any, index: number, array: any[]) => void A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
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

Inherited from

Array.forEach

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1435

includes

▸ includes(searchElement, fromIndex?): boolean

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

Name Type Description
searchElement any The element to search for.
fromIndex? number The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

Array.includes

Defined in

node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

indexOf

▸ indexOf(searchElement, fromIndex?): number

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

Name Type Description
searchElement any The value to locate in the array.
fromIndex? number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited from

Array.indexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1396

join

▸ join(separator?): string

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

Name Type Description
separator? string A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

Array.join

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1339

keys

▸ keys(): IterableIterator<number>

Returns an iterable of keys in the array

Returns

IterableIterator<number>

Inherited from

Array.keys

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:70

lastIndexOf

▸ lastIndexOf(searchElement, fromIndex?): number

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

Name Type Description
searchElement any The value to locate in the array.
fromIndex? number The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited from

Array.lastIndexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1402

map

▸ map<U>(callbackfn, thisArg?): U[]

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters

Name
U

Parameters

Name Type Description
callbackfn (value: any, index: number, array: any[]) => U A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
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

U[]

Inherited from

Array.map

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1441

mean

▸ mean(): number

Method

mean

Description

calculates the mean of the list

Returns

number

the mean of a (numeric) list

Defined in

src/utility/list.ts:72

median

▸ median(): number | List<T>

Method

median

Description

calculates the median of the list

Returns

number | List<T>

the median of the list

Defined in

src/utility/list.ts:81

mode

▸ mode(multimodal?): T

Method

mode

Description

calculates the mode of the list

Parameters

Name Type Default value Description
multimodal boolean false in the case of ties, return them all

Returns

T

the most frequently occuring element(s) in the list

Defined in

src/utility/list.ts:103

oneOf

▸ oneOf(): T

Method

onOf

Description

get a random element from the list

Returns

T

an element of the list

Defined in

src/utility/list.ts:167

pop

▸ pop(): any

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

any

Inherited from

Array.pop

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1317

push

▸ push(...items): number

Appends new elements to the end of an array, and returns the new length of the array.

Parameters

Name Type Description
...items any[] New elements to add to the array.

Returns

number

Inherited from

Array.push

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1322

reduce

▸ reduce(callbackfn): any

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

Name Type Description
callbackfn (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

any

Inherited from

Array.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1459

▸ reduce(callbackfn, initialValue): any

Parameters

Name Type
callbackfn (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any
initialValue any

Returns

any

Inherited from

Array.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1460

▸ reduce<U>(callbackfn, initialValue): 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.

Type parameters

Name
U

Parameters

Name Type Description
callbackfn (previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1466

reduceRight

▸ reduceRight(callbackfn): any

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

Name Type Description
callbackfn (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

any

Inherited from

Array.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1472

▸ reduceRight(callbackfn, initialValue): any

Parameters

Name Type
callbackfn (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any
initialValue any

Returns

any

Inherited from

Array.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1473

▸ reduceRight<U>(callbackfn, initialValue): 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.

Type parameters

Name
U

Parameters

Name Type Description
callbackfn (previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1479

remove

▸ remove(n): T

Method

remove

Description

removes an element from the list

Parameters

Name Type Description
n T element to remove

Returns

T

the element

Defined in

src/utility/list.ts:177

reverse

▸ reverse(): any[]

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

any[]

Inherited from

Array.reverse

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1344

shift

▸ shift(): any

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

any

Inherited from

Array.shift

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1349

shuffle

▸ shuffle(): void

Method

shuffle

Description

shuffle the list

Returns

void

Defined in

src/utility/list.ts:153

slice

▸ slice<T>(start?, end?): List<T>

Type parameters

Name
T

Parameters

Name Type
start? number
end? number

Returns

List<T>

Overrides

Array.slice

Defined in

src/utility/list.ts:20

some

▸ some(predicate, thisArg?): boolean

Determines whether the specified callback function returns true for any element of an array.

Parameters

Name Type Description
predicate (value: any, index: number, array: any[]) => 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.
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

Inherited from

Array.some

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1429

sort

▸ sort(compareFn?): List<T>

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

Name Type Description
compareFn? (a: any, b: any) => number Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they’re equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order. ts [11,2,22,1].sort((a, b) => a - b)

Returns

List<T>

Inherited from

Array.sort

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1370

splice

▸ splice(start, deleteCount?): any[]

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

Parameters

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount? number The number of elements to remove.

Returns

any[]

An array containing the elements that were deleted.

Inherited from

Array.splice

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1377

▸ splice(start, deleteCount, ...items): any[]

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

Parameters

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
...items any[] Elements to insert into the array in place of the deleted elements.

Returns

any[]

An array containing the elements that were deleted.

Inherited from

Array.splice

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1385

sum

▸ sum(): number

Method

sum

Description

sums a list

Returns

number

the sum of the lest, as per the + operator

Defined in

src/utility/list.ts:63

toLocaleString

▸ toLocaleString(): string

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Inherited from

Array.toLocaleString

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1312

toString

▸ toString(): string

Returns a string representation of an array.

Returns

string

Inherited from

Array.toString

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1308

unshift

▸ unshift(...items): number

Inserts new elements at the start of an array, and returns the new length of the array.

Parameters

Name Type Description
...items any[] Elements to insert at the start of the array.

Returns

number

Inherited from

Array.unshift

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1390

until

▸ until(value): List<T>

Method

until

Description

values from the start until a value

Parameters

Name Type Description
value T the value after the last value in the desired subset

Returns

List<T>

a subet of of elements of the list

Defined in

src/utility/list.ts:144

values

▸ values(): IterableIterator<any>

Returns an iterable of values in the array

Returns

IterableIterator<any>

Inherited from

Array.values

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:75

from

▸ Static from<T>(iter): List<T>

Type parameters

Name
T

Parameters

Name Type
iter ArrayLike<T>

Returns

List<T>

Overrides

Array.from

Defined in

src/utility/list.ts:12

isArray

▸ Static isArray(arg): arg is any[]

Parameters

Name Type
arg any

Returns

arg is any[]

Inherited from

Array.isArray

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1491

of

▸ Static of<T>(...items): T[]

Returns a new array from a set of elements.

Type parameters

Name
T

Parameters

Name Type Description
...items T[] A set of elements to include in the new array object.

Returns

T[]

Inherited from

Array.of

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:86