Class Sequence<V, K>`Abstract`

A sequence is an iterable Collection type with efficient index-based access.

Abstract

Type Parameters

V = any
K = any

Hierarchy

Collection
- Sequence
  - Deque

Index

Constructors

Accessors

Methods

add append clear contains empty entries get keys remove set values

Constructors

constructor

new Sequence<V, K>(): Sequence<V, K>
Type Parameters
- V = any
- K = any
Returns Sequence<V, K>

Inherited from Collection.constructor

Accessors

length

get length(): number
Returns number
Inherited from Collection.length
- Defined in src/collections/abc.ts:76

`Abstract` size

get size(): number
Returns the total number of elements in the collection.

Returns number
Inherited from Collection.size
- Defined in src/collections/abc.ts:74

Methods

`Abstract` add

add(item: any): any
Adds a new item to the collection.
Parameters
- item: any
  
  The item to add to the collection.
Returns any
Inherited from Collection.add
- Defined in src/collections/abc.ts:57

`Abstract` append

append(x: V | Iterable<V>): any
Adds a new item to the end of the sequence. Alias of add.

Memberof
Sequence
Parameters
- x: V | Iterable<V>
Returns any
- Defined in src/collections/abc.ts:119

`Abstract` clear

clear(): any
Remove all items from the collection

Returns any
Inherited from Collection.clear
- Defined in src/collections/abc.ts:69

`Abstract` contains

contains(item: any): boolean
Checks if item is present in the collection.

Returns
true when the element is found, else false
Parameters
- item: any
  
  The item to search for in the collection.
Returns boolean
Inherited from Collection.contains
- Defined in src/collections/abc.ts:64

empty

empty(): boolean
Check if there are no items.

Returns
true if is empty.

Returns boolean
Inherited from Collection.empty
- Defined in src/collections/abc.ts:84

`Abstract` entries

entries(): Iterable<[K, V]>
Returns an iterator of all the [key, value] pairs in order.

Returns Iterable<[K, V]>
- Defined in src/collections/abc.ts:139

`Abstract` get

get(key: K): any
Return the item at the given key or index

Memberof
Sequence
Parameters
- key: K
Returns any
- Defined in src/collections/abc.ts:102

`Abstract` keys

keys(): Iterable<K>
Returns an iterator of all the keys in order.

Returns Iterable<K>
- Defined in src/collections/abc.ts:130

`Abstract` remove

remove(x: V): any
Remove a given value from the collection if exists.

Returns
the value that was removed or undefined.
Parameters
- x: V
Returns any
- Defined in src/collections/abc.ts:125

`Abstract` set

set(key: K, value: V): any
Set a new value at the given key or index

Memberof
Sequence
Parameters
- key: K
- value: V
Returns any
- Defined in src/collections/abc.ts:111

`Abstract` values

values(): Iterable<V>
Returns an iterator of all the values in order.

Returns Iterable<V>
- Defined in src/collections/abc.ts:134

Generated using TypeDoc