Class List<T>

Type Parameters

Hierarchy

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

Implements

RelativeIndexable<T>

Index

Constructors

constructor

new List<T>(values?: null | Iterable<T, any, any> | readonly T[]): List<T>
Type Parameters
- T
Parameters
- Optionalvalues: null | Iterable<T, any, any> | 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

`Protected`_set

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

[iterator]

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

add

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

addListener

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

at

at(index: number): T
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: T): boolean
Parameters
- value: T
Returns boolean
- Defined in src/list.ts:119

deleteAt

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

emit

emit<T extends "add" | "update">(
event: T,
...args: ArgumentMap<{ add: [T]; update: [] }>[Extract<T, "add" | "update">],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "add" | "update"
Parameters
- event: T
- ...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: T): boolean
Parameters
- value: T
Returns boolean
- Defined in src/list.ts:125

insert

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

join

join(separator?: string): 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: "add" | "update"): 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 extends "add" | "update">(
    event: T,
): (
    ...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 extends "add" | "update">(
    event: T,
    fn?: (
        ...args: ArgumentMap<{ add: [T]; update: [] }>[Extract<
            T,
            "add"
            | "update",
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends "add" | "update"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<{ add: [T]; update: [] }>[Extract<
          T,
          "add"
          | "update",
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends "add" | "update">(
    event: T,
    fn: (
        ...args: ArgumentMap<{ add: [T]; update: [] }>[Extract<
            T,
            "add"
            | "update",
        >],
    ) => void,
    context?: any,
): 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
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends "add" | "update">(
    event: T,
    fn: (
        ...args: ArgumentMap<{ add: [T]; update: [] }>[Extract<
            T,
            "add"
            | "update",
        >],
    ) => void,
    context?: any,
): 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
- 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: T[]): number
Parameters
- ...items: T[]
Returns number
- Defined in src/list.ts:82

removeAllListeners

removeAllListeners(event?: "add" | "update"): 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 extends "add" | "update">(
    event: T,
    fn?: (
        ...args: ArgumentMap<{ add: [T]; update: [] }>[Extract<
            T,
            "add"
            | "update",
        >],
    ) => void,
    context?: any,
    once?: boolean,
): 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
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

set

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

splice

splice(start: number, deleteCount: number, ...items: T[]): T[]
Parameters
- start: number
- deleteCount: number
- ...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

Class List<T>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns List<T>

Properties

Readonly[toStringTag]

Protecteddata

Staticprefixed

Accessors

size

Returns number

Methods

Protected_set

Parameters

Returns void

[iterator]

Returns IterableIterator<T>

add

Parameters

Returns this

addListener

Type Parameters

Parameters

Returns this

at

Parameters

Returns T

clear

Returns void

delete

Parameters

Returns boolean

deleteAt

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

entries

Returns IterableIterator<[number, T]>

eventNames

Returns ("add" | "update")[]

has

Parameters

Returns boolean

insert

Parameters

Returns void

join

Parameters

Returns string

keys

Returns IterableIterator<number>

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ...args: ArgumentMap<{ add: [T]; update: [] }>[Extract< T, "add" | "update", >],) => void[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

`Readonly`[toStringTag]

`Protected`data

`Static`prefixed

`Protected`_set

Returns (
...args: ArgumentMap<{ add: [T]; update: [] }>[Extract<
T,
"add"
| "update",
>],
) => void[]