Class SetStringMutable<V>

Mutable string set

Type Parameters

Hierarchy (View Summary)

SimpleEventEmitter<ValueSetEventMap<V>>
- SetStringMutable

Implements

ISetMutable<V>

Index

Constructors

constructor

new SetStringMutable<V>(keyString: undefined | ToString<V>): SetStringMutable<V>
Constructor
Type Parameters
- V
Parameters
- keyString: undefined | ToString<V>
  Function which returns a string version of added items. If unspecified JSON.stringify
Returns SetStringMutable<V>
Overrides SimpleEventEmitter.constructor

Properties

keyString

keyString: ToString<V>

store

store: Map<string, V> = ...

Accessors

isDisposed

get isDisposed(): boolean
Returns boolean
Implementation of ISetMutable.isDisposed
Inherited from SimpleEventEmitter.isDisposed

size

get size(): number
Number of items stored in set

Returns number
Implementation of ISetMutable.size

Methods

add

add(...values: V[]): boolean
Adds one or more items to set. add event is fired for each item
Parameters
- ...values: V[]
  items to add
Returns boolean
Implementation of ISetMutable.add

addEventListener

addEventListener<K extends keyof ValueSetEventMap<V>>(
    name: K,
    listener: (
        event: ValueSetEventMap<V>[K],
        sender: SimpleEventEmitter<ValueSetEventMap<V>>,
    ) => void,
): void
Adds event listener.
Type Parameters
- Kextendskeyof ValueSetEventMap<V>
  Events
Parameters
- name: K
  Event name
- listener: (
  event: ValueSetEventMap<V>[K],
  sender: SimpleEventEmitter<ValueSetEventMap<V>>,
  ) => void
  Event handler
Returns void
Throws
Error if emitter is disposed

Implementation of ISetMutable.addEventListener
Inherited from SimpleEventEmitter.addEventListener

clear

clear(): void
Clear items from set

Returns void
Implementation of ISetMutable.clear

delete

delete(v: V): boolean
Delete value from set.
Parameters
- v: V
  Value to delete
Returns boolean
True if item was found and removed

Implementation of ISetMutable.delete

dispose

dispose(): void
Returns void
Implementation of ISetMutable.dispose
Inherited from SimpleEventEmitter.dispose

`Protected`fireEvent

fireEvent<K extends keyof ValueSetEventMap<V>>(
type: K,
args: ValueSetEventMap<V>[K],
): void
Fire event
Type Parameters
- Kextendskeyof ValueSetEventMap<V>
Parameters
- type: K
  Type of event
- args: ValueSetEventMap<V>[K]
  Arguments for event
Returns void
Implementation of ISetMutable.fireEvent
Inherited from SimpleEventEmitter.fireEvent

has

has(v: V): boolean
Returns true if item exists in set
Parameters
- v: V
Returns boolean
Implementation of ISetMutable.has

removeEventListener

removeEventListener<K extends keyof ValueSetEventMap<V>>(
    type: K,
    listener: (
        event: ValueSetEventMap<V>[K],
        sender: SimpleEventEmitter<ValueSetEventMap<V>>,
    ) => void,
): void
Remove event listener
Type Parameters
- Kextendskeyof ValueSetEventMap<V>
Parameters
- type: K
- listener: (
  event: ValueSetEventMap<V>[K],
  sender: SimpleEventEmitter<ValueSetEventMap<V>>,
  ) => void
Returns void
Implementation of ISetMutable.removeEventListener
Inherited from SimpleEventEmitter.removeEventListener

toArray

toArray(): V[]
Returns array copy of set

Returns V[]
Array copy of set

Implementation of ISetMutable.toArray

values

values(): MapIterator<V>
Returns values from set as an iterable

Returns MapIterator<V>
Implementation of ISetMutable.values

Class SetStringMutable<V>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SetStringMutable<V>

Properties

keyString

store

Accessors

isDisposed

Returns boolean

size

Returns number

Methods

add

Parameters

Returns boolean

addEventListener

Type Parameters

Parameters

Returns void

Throws

clear

Returns void

delete

Parameters

Returns boolean

dispose

Returns void

ProtectedfireEvent

Type Parameters

Parameters

Returns void

has

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

toArray

Returns V[]

values

Returns MapIterator<V>

Settings

On This Page

`Protected`fireEvent