Class List<T>

Type Parameters

T

Hierarchy

EventEmitter<{
add: [T];
update: [];
}>
- List

Implements

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: []; add: [T]; }>.constructor
- Defined in src/list.ts:12

Properties

`Readonly`[toStringTag]

[toStringTag]: "List" = 'List'

`Protected`data

data: Set<T> = ...

`Static`prefixed

prefixed: string | boolean

Accessors

size

get size(): number
Returns number
- Defined in src/list.ts:129

Methods

[iterator]

[iterator](): IterableIterator<T>
Returns IterableIterator<T>
- Defined in src/list.ts:147

`Protected`_set

_set(index, value, _delete?): void
Parameters
- index: number
- value: T
- _delete: boolean = false
Returns void
- Defined in src/list.ts:37

add

add(value): this
Parameters
- value: T
Returns this
- Defined in src/list.ts:107

addListener

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

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:66

clear

clear(): void
Returns void
- Defined in src/list.ts:114

delete

delete(value): boolean
Parameters
- value: T
Returns boolean
- Defined in src/list.ts:119

deleteAt

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

emit

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

entries

entries(): IterableIterator<[number, T]>
Returns IterableIterator<[number, T]>
- Defined in src/list.ts:135

eventNames

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

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

has

has(value): boolean
Parameters
- value: T
Returns boolean
- Defined in src/list.ts:125

insert

insert(value, index?): void
Parameters
- value: T
- index: number = ...
Returns void
- Defined in src/list.ts:60

join

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

keys

keys(): IterableIterator<number>
Returns IterableIterator<number>
- Defined in src/list.ts:139

listenerCount

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

listeners

listeners<T>(event): ((...args: ArgumentMap<{
add: [T];
update: [];
}>[Extract<T, "add" | "update">]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "add" | "update"
Parameters
- event: T
Returns ((...args: ArgumentMap<{
add: [T];
update: [];
}>[Extract<T, "add" | "update">]) => 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 "add" | "update"
Parameters
- event: T
- Optionalfn: ((...args: ArgumentMap<{
  add: [T];
  update: [];
  }>[Extract<T, "add" | "update">]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<{
      add: [T];
      update: [];
      }>[Extract<T, "add" | "update">]
      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 "add" | "update"
Parameters
- event: T
- fn: ((...args: ArgumentMap<{
  add: [T];
  update: [];
  }>[Extract<T, "add" | "update">]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<{
      add: [T];
      update: [];
      }>[Extract<T, "add" | "update">]
      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 "add" | "update"
Parameters
- event: T
- fn: ((...args: ArgumentMap<{
  add: [T];
  update: [];
  }>[Extract<T, "add" | "update">]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<{
      add: [T];
      update: [];
      }>[Extract<T, "add" | "update">]
      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:74

push

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

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: "add" | "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 "add" | "update"
Parameters
- event: T
- Optionalfn: ((...args: ArgumentMap<{
  add: [T];
  update: [];
  }>[Extract<T, "add" | "update">]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<{
      add: [T];
      update: [];
      }>[Extract<T, "add" | "update">]
      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:48

splice

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

toArray

toArray(): T[]
Returns T[]
- Defined in src/list.ts:25

toJSON

toJSON(): string
Returns string
- Defined in src/list.ts:29

toSet

toSet(): Set<T>
Returns Set<T>
- Defined in src/list.ts:21

toString

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

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

values

values(): IterableIterator<T>
Returns IterableIterator<T>
- Defined in src/list.ts:143