Class SetStringMutable<V>

Mutable string set

Type Parameters

Hierarchy (View Summary)

SimpleEventEmitter<ValueSetEventMap<V>>
- SetStringMutable

Implements

ISetMutable<V>

Index

Accessors

isDisposed

get isDisposed(): boolean
Returns boolean
Implementation of ISetMutable.isDisposed
Inherited from SimpleEventEmitter.isDisposed
- Defined in packages/events/src/simple-event-emitter.ts:13

size

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

Returns number
Implementation of ISetMutable.size
- Defined in packages/collections/src/set/set-mutable.ts:39

Constructors

constructor

new SetStringMutable<V>(
keyString: undefined | ToString<V>,
): Sets.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 Sets.SetStringMutable<V>
Overrides SimpleEventEmitter.constructor
- Defined in packages/collections/src/set/set-mutable.ts:31

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
- Defined in packages/collections/src/set/set-mutable.ts:47

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
- K extends keyof 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
- Defined in packages/events/src/simple-event-emitter.ts:39

clear

clear(): void
Clear items from set

Returns void
Implementation of ISetMutable.clear
- Defined in packages/collections/src/set/set-mutable.ts:71

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
- Defined in packages/collections/src/set/set-mutable.ts:81

dispose

dispose(): void
Returns void
Implementation of ISetMutable.dispose
Inherited from SimpleEventEmitter.dispose
- Defined in packages/events/src/simple-event-emitter.ts:8

`Protected`fireEvent

fireEvent<K extends keyof ValueSetEventMap<V>>(
type: K,
args: ValueSetEventMap<V>[K],
): void
Fire event
Type Parameters
- K extends keyof 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
- Defined in packages/events/src/simple-event-emitter.ts:23

has

has(v: V): boolean
Returns true if item exists in set
Parameters
- v: V
Returns boolean
Implementation of ISetMutable.has
- Defined in packages/collections/src/set/set-mutable.ts:92

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
- K extends keyof 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
- Defined in packages/events/src/simple-event-emitter.ts:55

toArray

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

Returns V[]
Array copy of set
Implementation of ISetMutable.toArray
- Defined in packages/collections/src/set/set-mutable.ts:100

values

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

Returns MapIterator<V>
Implementation of ISetMutable.values
- Defined in packages/collections/src/set/set-mutable.ts:64

Class SetStringMutable<V>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Accessors

Constructors

Methods

Properties

Accessors

isDisposed

Returns boolean

size

Returns number

Constructors

constructor

Type Parameters

Parameters

Returns Sets.SetStringMutable<V>

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>

Properties

keyString

store

Settings

On This Page

`Protected`fireEvent