Class ReadonlySvelteSet<T>

Provides a readonly variant of SvelteSet wrapping an instance of SvelteSet as the source.

Type Parameters

T

Implements

ReadonlySet<T>
Readable<ReadonlySvelteSet<T>>

Index

Constructors

Accessors

Methods

[iterator] difference entries forEach has intersection isDisjointFrom isSubsetOf isSupersetOf keys subscribe symmetricDifference union values

Constructors

constructor

new ReadonlySvelteSet<T>(svelteSet: SvelteSet<T>): ReadonlySvelteSet<T>
Creates a readonly variant of SvelteSet.
Type Parameters
- T
Parameters
- svelteSet: SvelteSet<T>
  Backing wrapped SvelteSet implementation.
Returns ReadonlySvelteSet<T>

Accessors

size

get size(): number

Returns the number of unique elements in this set.

Returns number

Implementation of ReadonlySet.size

Methods

[iterator]

"[iterator]"(): SetIterator<T>

Iterates over values in the set.

Returns SetIterator<T>

Implementation of ReadonlySet.[iterator]

difference

difference<U>(other: ReadonlySetLike<U>): Set<T>
Type Parameters
- U
Parameters
- other: ReadonlySetLike<U>
Returns Set<T>
a new Set containing all the elements in this Set which are not also in the argument.

entries

entries(): SetIterator<[T, T]>

Returns an iterable of [v,v] pairs for every value v in the set.

Returns SetIterator<[T, T]>

Implementation of ReadonlySet.entries

forEach

forEach(
callbackfn: (value: T, value2: T, set: ReadonlySet<T>) => void,
thisArg?: any,
): void
Executes a provided function once for each value in this set, in insertion order.
Parameters
- callbackfn: (value: T, value2: T, set: ReadonlySet<T>) => void
  Callback function.
- OptionalthisArg: any
  Optional this reference for callback function.
Returns void

Implementation of ReadonlySet.forEach

has

has(value: T): boolean
Returns a boolean indicating whether an element with the specified value exists in this set or not.
Parameters
- value: T
  Value to test.
Returns boolean

Implementation of ReadonlySet.has

intersection

intersection<U>(other: ReadonlySetLike<U>): Set<T & U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike<U>
Returns Set<T & U>
a new Set containing all the elements which are both in this Set and in the argument.

isDisjointFrom

isDisjointFrom(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether this Set has no elements in common with the argument.

isSubsetOf

isSubsetOf(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in this Set are also in the argument.

isSupersetOf

isSupersetOf(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in the argument are also in this Set.

keys

keys(): SetIterator<T>

Despite its name, returns an iterable of the values in the set.

Returns SetIterator<T>

Implementation of ReadonlySet.keys

subscribe(handler: Subscriber<ReadonlySvelteSet<T>>): Unsubscriber
Parameters
- handler: Subscriber<ReadonlySvelteSet<T>>
  Callback function that is invoked on update / changes.
Returns Unsubscriber
Unsubscribe function.

Implementation of Readable.subscribe

symmetricDifference

symmetricDifference<U>(other: ReadonlySetLike<U>): Set<T | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike<U>
Returns Set<T | U>
a new Set containing all the elements which are in either this Set or in the argument, but not in both.

union

union<U>(other: ReadonlySetLike<U>): Set<T | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike<U>
Returns Set<T | U>
a new Set containing all the elements in this Set and also all the elements in the argument.

values

values(): SetIterator<T>

Returns an iterable of values in the set.

Returns SetIterator<T>

Implementation of ReadonlySet.values