@blackglory/structures 0.6.2 → 0.6.5

package/README.md

@@ -12,6 +12,8 @@ yarn add @blackglory/structures
 ### Box
 ```ts
 class Box<T> {
+  get [Symbol.toStringTag](): string
+
   constructor(value: T)
 
   get(): T 
@@ -52,11 +54,11 @@ class Emitter<EventToArgs extends Record<string, unknown[]>> {
 
 ### HashMap
 ```ts
-class HashMap<K, V, H = unknown> {
+class HashMap<K, V, Hash = unknown> {
   get [Symbol.toStringTag](): string
   get size(): number
 
-  constructor(hash: (key: K) => H)
+  constructor(hash: (key: K) => Hash)
 
   set(key: K, value: V): this
   has(key: K): boolean
@@ -68,12 +70,12 @@ class HashMap<K, V, H = unknown> {
 
 ### HashSet
 ```ts
-class HashSet<V, H = unknown> implements Iterable<V> {
+class HashSet<V, Hash = unknown> implements Iterable<V> {
   get [Symbol.toStringTag](): string
   get size(): number
   [Symbol.iterator](): IterableIterator<V>
 
-  constructor(hash: (value: V) => H)
+  constructor(hash: (value: V) => Hash)
 
   add(value: V): this
   delete(value: V): boolean
@@ -166,6 +168,7 @@ type IFiniteStateMachineSchema<State extends string, Event extends string> =
   Record<State, Partial<Record<Event, State>>>
 
 class FiniteStateMachine<State extends string, Event extends string> {
+  get [Symbol.toStringTag](): string
   get state(): State
 
   constructor(
@@ -198,6 +201,20 @@ class ObservableFiniteStateMachine<
   State extends string
 , Event extends string
 > extends FiniteStateMachine<State, Event> {
+  get [Symbol.toStringTag](): string
+
   observeStateChanges(): Observable<IFiniteStateMachineStateChange<State, Event>>
 }
 ```
+
+### SparseSet
+```ts
+class SparseSet {
+  get [Symbol.toStringTag](): string
+  get [Symbol.iterator](): IterableIterator<number>
+
+  add(value: number): void
+  has(value: number): boolean
+  remove(value: number): void
+}
+```