Class List<T>

Type Parameters

T

Hierarchy

EventEmitter<"update">
- List

Implements

Set<T>
RelativeIndexable<T>

Index

Constructors

Properties

[toStringTag] data prefixed

Accessors

Constructors

constructor

new List<T>(values?): List<T>
Type Parameters
- T
Parameters
- Optionalvalues: null | Iterable<T> | readonly T[]
Returns List<T>
Overrides EventEmitter<'update'>.constructor
- Defined in src/list.ts:6

Properties

`Readonly`[toStringTag]

[toStringTag]: "List" = 'List'

`Protected`data

data: Set<T> = ...

`Static`prefixed

prefixed: string | boolean

Accessors

size

get size(): number
Returns number
the number of (unique) elements in Set.
Implementation of Set.size
- Defined in src/list.ts:143

Methods

[iterator]

[iterator](): IterableIterator<T>
Returns IterableIterator<T>
Implementation of Set.[iterator]
- Defined in src/list.ts:159

add

add(value): this
Appends a new element with a specified value to the end of the Set.
Parameters
- value: T
Returns this
Implementation of Set.add
- Defined in src/list.ts:89

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends "update"
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

array

array(): T[]
Returns T[]
- Defined in src/list.ts:15

at

at(index): T
Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.
Parameters
- index: number
Returns T
Implementation of RelativeIndexable.at
- Defined in src/list.ts:48

clear

clear(): void
Returns void
Implementation of Set.clear
- Defined in src/list.ts:95

delete

delete(value): boolean
Removes a specified value from the Set.
Parameters
- value: T
Returns boolean
Returns true if an element in the Set existed and has been removed, or false if the element does not exist.
Implementation of Set.delete
- Defined in src/list.ts:100

deleteAt

deleteAt(index): void
Parameters
- index: number
Returns void
- Defined in src/list.ts:38

difference

difference<U>(other): List<T>
Type Parameters
- U
Parameters
- other: ReadonlySetLike<U>
Returns List<T>
a new Set containing all the elements in this Set which are not also in the argument.
Implementation of Set.difference
- Defined in src/list.ts:114

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "update"
Parameters
- event: T
- Rest...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

entries

entries(): IterableIterator<[T, T]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns IterableIterator<[T, T]>
Implementation of Set.entries
- Defined in src/list.ts:147

eventNames

eventNames(): "update"[]
Return an array listing the events for which the emitter has registered listeners.

Returns "update"[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each value in the Set object, in insertion order.
Parameters
- callbackfn: ((value: T, value2: T, list: List<T>) => void)
  - - (value, value2, list): void
    - Parameters
      value: T
      value2: T
      list: List<T>
      Returns void
- OptionalthisArg: any
Returns void
Implementation of Set.forEach
- Defined in src/list.ts:135

has

has(value): boolean
Parameters
- value: T
Returns boolean
a boolean indicating whether an element with the specified value exists in the Set or not.
Implementation of Set.has
- Defined in src/list.ts:139

intersection

intersection<U>(other): List<T & U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike<U>
Returns List<T & U>
a new Set containing all the elements which are both in this Set and in the argument.
Implementation of Set.intersection
- Defined in src/list.ts:110

isDisjointFrom

isDisjointFrom(other): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether this Set has no elements in common with the argument.
Implementation of Set.isDisjointFrom
- Defined in src/list.ts:130

isSubsetOf

isSubsetOf(other): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in this Set are also in the argument.
Implementation of Set.isSubsetOf
- Defined in src/list.ts:122

isSupersetOf

isSupersetOf(other): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in the argument are also in this Set.
Implementation of Set.isSupersetOf
- Defined in src/list.ts:126

join

join(separator?): string
Parameters
- Optionalseparator: string
Returns string
- Defined in src/list.ts:71

json

json(): string
Returns string
- Defined in src/list.ts:19

keys

keys(): IterableIterator<T>
Despite its name, returns an iterable of the values in the set.

Returns IterableIterator<T>
Implementation of Set.keys
- Defined in src/list.ts:151

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: "update"
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "update"
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends "update"
Parameters
- event: T
- Optionalfn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends "update"
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends "update"
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

pop

pop(): undefined | T
Returns undefined | T
- Defined in src/list.ts:56

push

push(...items): number
Parameters
- Rest...items: T[]
Returns number
- Defined in src/list.ts:64

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: "update"
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends "update"
Parameters
- event: T
- Optionalfn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

set

set(index, value): void
Parameters
- index: number
- value: T
Returns void
- Defined in src/list.ts:27

splice

splice(start, deleteCount, ...items): T[]
Parameters
- start: number
- deleteCount: number
- Rest...items: T[]
Returns T[]
- Defined in src/list.ts:75

symmetricDifference

symmetricDifference<U>(other): List<T | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike<U>
Returns List<T | U>
a new Set containing all the elements which are in either this Set or in the argument, but not in both.
Implementation of Set.symmetricDifference
- Defined in src/list.ts:118

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in src/list.ts:23

union

union<U>(other): List<T | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike<U>
Returns List<T | U>
a new Set containing all the elements in this Set and also all the elements in the argument.
Implementation of Set.union
- Defined in src/list.ts:106

values

values(): IterableIterator<T>
Returns an iterable of values in the set.

Returns IterableIterator<T>
Implementation of Set.values
- Defined in src/list.ts:155