@ralphschuler.better set.BetterSet

Class: BetterSet<v>

@ralphschuler/better-set.BetterSet

A better Set class with more methods.

Type parameters

Name	Description
v	The type of the values.

Hierarchy

• Set<v>

  ↳ BetterSet

Table of contents

Constructors

• constructor

Properties

• [toStringTag]
• size
• [species]

Methods

• [iterator]
• add
• both
• clear
• delete
• entries
• except
• filter
• forEach
• has
• keys
• merge
• values

Constructors

constructor

• new BetterSet<v>(values?): BetterSet<v>

Type parameters

Name
v

Parameters

Name	Type
values?	null | readonly v[]

Returns

BetterSet<v>

Inherited from

Set<v>.constructor

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:116

• new BetterSet<v>(iterable?): BetterSet<v>

Type parameters

Name
v

Parameters

Name	Type
iterable?	null | Iterable<v>

Returns

BetterSet<v>

Inherited from

Set<v>.constructor

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:207

Properties

[toStringTag]

• Readonly [toStringTag]: string

Inherited from

Set.[toStringTag]

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:145

---

size

• Readonly size: number

Inherited from

Set.size

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:112

---

[species]

▪ Static Readonly [species]: SetConstructor

Inherited from

Set.[species]

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:322

Methods

[iterator]

▸ [iterator](): IterableIterator<v>

Iterates over values in the set.

Returns

IterableIterator<v>

Inherited from

Set.[iterator]

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:170

---

add

▸ add(value): BetterSet<v>

Appends a new element with a specified value to the end of the Set.

Parameters

Name	Type
value	v

Returns

BetterSet<v>

Inherited from

Set.add

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:93

---

both

▸ both(set): Set<v>

Maps the set by a predicate.

Parameters

Name	Type
set	Set<v>

Returns

Set<v>

A new set with the mapped values.

Defined in

packages/better-set/src/index.ts:56

---

clear

▸ clear(): void

Returns

void

Inherited from

Set.clear

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:95

---

delete

▸ delete(value): boolean

Removes a specified value from the Set.

Parameters

Name	Type
value	v

Returns

boolean

Returns true if an element in the Set existed and has been removed, or false if the element does not exist.

Inherited from

Set.delete

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:100

---

entries

▸ entries(): IterableIterator<[v, v]>

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

Returns

IterableIterator<[v, v]>

Inherited from

Set.entries

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:174

---

except

▸ except(set): Set<v>

Maps the set by a predicate.

Parameters

Name	Type
set	Set<v>

Returns

Set<v>

A new set with the mapped values.

Defined in

packages/better-set/src/index.ts:41

---

filter

▸ filter(predicate): BetterSet<v>

Filters the set by a predicate.

Parameters

Name	Type	Description
predicate	(v: v) => boolean	The predicate to filter by.

Returns

BetterSet<v>

A new set with the filtered values.

Defined in

packages/better-set/src/index.ts:13

---

forEach

▸ forEach(callbackfn, thisArg?): void

Executes a provided function once per each value in the Set object, in insertion order.

Parameters

Name	Type
callbackfn	(value: v, value2: v, set: Set<v>) => void
thisArg?	any

Returns

void

Inherited from

Set.forEach

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:104

---

has

▸ has(value): boolean

Parameters

Name	Type
value	v

Returns

boolean

a boolean indicating whether an element with the specified value exists in the Set or not.

Inherited from

Set.has

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:108

---

keys

▸ keys(): IterableIterator<v>

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

Returns

IterableIterator<v>

Inherited from

Set.keys

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:178

---

merge

▸ merge(set): void

Maps the set by a predicate.

Parameters

Name	Type
set	Set<v>

Returns

void

A new set with the mapped values.

Defined in

packages/better-set/src/index.ts:28

---

values

▸ values(): IterableIterator<v>

Returns an iterable of values in the set.

Returns

IterableIterator<v>

Inherited from

Set.values

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:183