Class ArrayView<T>

Helper type for viewing-only arrays, with some viewing methods of Array.

Type Parameters

T

Implements

ArrayRead<T>

Index

Constructors

Properties

_at _equal _length _lengthFn

Accessors

Methods

[iterator] at indexOf map reduce

Constructors

constructor

new ArrayView<T>(
    _lengthFn: () => number,
    _at: (idx: number) => T,
    _equal: (a: T, b: T) => boolean,
): ArrayView<T>
Type Parameters
- T
Parameters
- _lengthFn: () => number
  Length of array
- _at: (idx: number) => T
  Accessor to an array element at index idx
- _equal: (a: T, b: T) => boolean
Returns ArrayView<T>
- Defined in src/structures/shared.ts:38

Properties

`Protected` `Readonly`_at

_at: (idx: number) => T

Accessor to an array element at index idx

`Protected` `Readonly`_equal

_equal: (a: T, b: T) => boolean

`Protected`_length

_length: null | number = null

`Protected` `Readonly`_lengthFn

_lengthFn: () => number

Length of array

Accessors

length

get length(): number
Returns number
Implementation of ArrayRead.length
- Defined in src/structures/shared.ts:50

Methods

[iterator]

"[iterator]"(): Generator<T, undefined, unknown>
Same as Array.prototype[Symbol.iterator]

Returns Generator<T, undefined, unknown>
Implementation of ArrayRead.[iterator]
- Defined in src/structures/shared.ts:71

at

at(idx: number): T
Same as hooked-access [] to an array. Throws over ArrayView._at.
Parameters
- idx: number
  Index of element to access, must be positive and strictly inferior to array length
Returns T
Implementation of ArrayRead.at
- Defined in src/structures/shared.ts:59

indexOf

indexOf(el: T, fromIndex?: number): number
Same as Array.prototype.indexOf
Parameters
- el: T
- fromIndex: number = 0
Returns number
Implementation of ArrayRead.indexOf
- Defined in src/structures/shared.ts:80

map

map<U>(
callbackfn: (value: T, index: number, array: ArrayRead<T>) => U,
): ArrayRead<U>
Type Parameters
- U
Parameters
- callbackfn: (value: T, index: number, array: ArrayRead<T>) => U
Returns ArrayRead<U>
Implementation of ArrayRead.map
- Defined in src/structures/shared.ts:85

reduce

reduce<U>(
    callbackfn: (
        previousValue: U,
        currentValue: T,
        currentIndex: number,
        array: ArrayRead<T>,
    ) => U,
    initialValue: U,
): U
Type Parameters
- U
Parameters
- callbackfn: (
      previousValue: U,
      currentValue: T,
      currentIndex: number,
      array: ArrayRead<T>,
  ) => U
- initialValue: U
Returns U
Implementation of ArrayRead.reduce
- Defined in src/structures/shared.ts:91