Class DeltaSet<T>

A Set implementation that keeps a delta of changes made to it.

Type Parameters

T

A type of elements of delta set.

Hierarchy

Set<T>
- DeltaSet

Implements

ReadonlyDeltaSet<T>

Index

Constructors

constructor

new DeltaSet<T>(values?): DeltaSet<T>
Constructs new delta set.
Type Parameters
- T
Parameters
- Optional values: null | Iterable<T>
  
  An iterable of elements be added to constructed delta set. Or null to add nothing.
Returns DeltaSet<T>
Overrides Set<T>.constructor
- Defined in proc7ts/delta-set/src/delta-set.ts:18

Properties

`Private` `Readonly` #added

#added: Set<T>

`Private` `Readonly` #removed

#removed: Set<T>

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` size

size: number

Returns

the number of (unique) elements in Set.

`Static` `Readonly` [species]

[species]: SetConstructor

Methods

[iterator]

[iterator](): IterableIterator<T>
Iterates over values in the set.

Returns IterableIterator<T>
Implementation of ReadonlyDeltaSet.[iterator]

Inherited from Set.[iterator]
- Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2015.iterable.d.ts:170

add

add(value): DeltaSet<T>
Appends a new element with a specified value to the end of this delta set. Unless the set contains this element already.

Records element addition and forgets its removal unless the set contains it already.
Parameters
- value: T
  
  The value of the element to add.
Returns DeltaSet<T>
this delta set.
Overrides Set.add
- Defined in proc7ts/delta-set/src/delta-set.ts:35

clear

clear(): void
Removes all elements from this delta set.

Records all elements removal and forgets all elements additions.

Returns void
Overrides Set.clear
- Defined in proc7ts/delta-set/src/delta-set.ts:70

delete

delete(value): boolean
Removes the specified element from this delta set.

Records element removal and forgets its addition if removal succeed.
Parameters
- value: T
  
  The value of the element to remove.
Returns boolean
true if element removed successfully; or false if this set did not contain the element.
Overrides Set.delete
- Defined in proc7ts/delta-set/src/delta-set.ts:54

delta

delta(add, remove?): DeltaSet<T>
Applies changes to this delta set.

First removes elements to remove. Then appends elements to add.

Records all changes made.
Parameters
- add: Iterable<T>
  
  An iterable of elements to add.
- remove: Iterable<T> = []
  
  An iterable of elements to remove.
Returns DeltaSet<T>
this delta set.
- Defined in proc7ts/delta-set/src/delta-set.ts:88

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 ReadonlyDeltaSet.entries

Inherited from Set.entries
- Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2015.iterable.d.ts:174

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each value in the Set object, in insertion order.
Parameters
- callbackfn: ((value, value2, set) => void)
  - - (value, value2, set): void
    - Parameters
      
      value: T
      
      value2: T
      
      set: Set<T>
      
      Returns void
- Optional thisArg: any
Returns void
Implementation of ReadonlyDeltaSet.forEach

Inherited from Set.forEach
- Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2015.collection.d.ts:105

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 ReadonlyDeltaSet.has

Inherited from Set.has
- Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2015.collection.d.ts:109

keys

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

Returns IterableIterator<T>
Implementation of ReadonlyDeltaSet.keys

Inherited from Set.keys
- Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2015.iterable.d.ts:178

redelta

redelta(receiver): DeltaSet<T>
Replays the changes made to this set in target receiver.
Parameters
- receiver: DeltaReceiver<T>
  
  A receiver of changes delta. E.g. another Set.
Returns DeltaSet<T>
this delta set.
Implementation of ReadonlyDeltaSet.redelta
- Defined in proc7ts/delta-set/src/delta-set.ts:101

undelta

undelta(): DeltaSet<T>
Forgets all changes made to this set.

Does not alter the set contents.

Returns DeltaSet<T>
this delta set.
- Defined in proc7ts/delta-set/src/delta-set.ts:116

values

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

Returns IterableIterator<T>
Implementation of ReadonlyDeltaSet.values

Inherited from Set.values
- Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2015.iterable.d.ts:183

Class DeltaSet<T>

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

Optional values: null | Iterable<T>

Returns DeltaSet<T>

Properties

Private Readonly #added

Private Readonly #removed

Readonly [toStringTag]

Readonly size

Returns

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<T>

add

Parameters

value: T

Returns DeltaSet<T>

clear

Returns void

delete

Parameters

value: T

Returns boolean

delta

Parameters

add: Iterable<T>

remove: Iterable<T> = []

Returns DeltaSet<T>

entries

Returns IterableIterator<[T, T]>

forEach

Parameters

callbackfn: ((value, value2, set) => void)

Parameters

value: T

value2: T

set: Set<T>

Returns void

Optional thisArg: any

Returns void

has

Parameters

value: T

Returns boolean

keys

Returns IterableIterator<T>

redelta

Parameters

receiver: DeltaReceiver<T>

Returns DeltaSet<T>

undelta

Returns DeltaSet<T>

values

Returns IterableIterator<T>

Settings

Member Visibility

Theme

On This Page

`Optional` values: null | Iterable<T>

`Private` `Readonly` #added

`Private` `Readonly` #removed

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]

`Optional` thisArg: any