Interface IEquivSet<T>

Type parameters

T

Hierarchy

Set<T>
IClear
ICopy<IEquivSet<T>>
IEmpty<IEquivSet<T>>
IEquiv
IGet<T, T>
IInto<T, IEquivSet<T>>
- IEquivSet

Implemented by

Index

Properties

Methods

Properties

Set

Set: SetConstructor

Readonly [Symbol.toStringTag]

[Symbol.toStringTag]: string

Readonly size

size: number

Methods

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<T>

Inherited from IEquivSet.[Symbol.iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:171
Iterates over values in the set.
Returns IterableIterator<T>

add

add(value: T): this

Inherited from IEquivSet.add
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:59
Parameters
- value: T
Returns this

clear

clear(): void

Inherited from IEquivSet.clear
Overrides IClear.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:60
Returns void

copy

copy(): IEquivSet<T>

Inherited from IEquivSet.copy
- Defined in packages/api/api/copy.d.ts:9
Returns a copy of this instance. Shallow or deep copies are implementation specific.
Returns IEquivSet<T>

delete

delete(value: T): boolean

Inherited from IEquivSet.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:61
Parameters
- value: T
Returns boolean

disj

disj(xs: Iterable<T>): this

- Defined in packages/associative/src/api.ts:21
Parameters
- xs: Iterable<T>
Returns this

empty

empty(): IEquivSet<T>

Inherited from IEquivSet.empty
- Defined in packages/api/api/empty.d.ts:6
Returns an empty/blank instance of same type (with possibly same config, if any).
Returns IEquivSet<T>

entries

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

Inherited from IEquivSet.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:175
Returns an iterable of [v,v] pairs for every value v in the set.
Returns IterableIterator<[T, T]>

equiv

equiv(o: any): boolean

Inherited from IEquivSet.equiv
- Defined in packages/api/api/equiv.d.ts:8
Returns true if this value is equivalent to o. Also see {@link ICompare.compare} and {@link IHash.hash}.
Parameters
- o: any
  value to check for equivalence
Returns boolean

first

first(): T | undefined

- Defined in packages/associative/src/api.ts:22
Returns T | undefined

forEach

forEach(callbackfn: (value: T, value2: T, set: Set<T>) => void, thisArg?: any): void

Inherited from IEquivSet.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:62
Parameters
- callbackfn: (value: T, value2: T, set: Set<T>) => void
  - - (value: T, value2: T, set: Set<T>): void
    - Parameters
      - value: T
      - value2: T
      - set: Set<T>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: T, notfound?: V): T | undefined

Inherited from IEquivSet.get
- Defined in packages/api/api/get.d.ts:6
Parameters
- key: T
- Optional notfound: V
Returns T | undefined

has

has(value: T): boolean

Inherited from IEquivSet.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:63
Parameters
- value: T
Returns boolean

into

into(coll: Iterable<T>): IEquivSet<T>

Inherited from IEquivSet.into
- Defined in packages/api/api/into.d.ts:6
Parameters
- coll: Iterable<T>
Returns IEquivSet<T>

keys

keys(): IterableIterator<T>

Inherited from IEquivSet.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:179
Despite its name, returns an iterable of the values in the set.
Returns IterableIterator<T>

values

values(): IterableIterator<T>

Inherited from IEquivSet.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:184
Returns an iterable of values in the set.
Returns IterableIterator<T>

Generated using TypeDoc