@blackglory/structures 0.6.4 → 0.6.7

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 
@@ -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,8 @@ class ObservableFiniteStateMachine<
   State extends string
 , Event extends string
 > extends FiniteStateMachine<State, Event> {
+  get [Symbol.toStringTag](): string
+
   observeStateChanges(): Observable<IFiniteStateMachineStateChange<State, Event>>
 }
 ```
@@ -205,10 +210,39 @@ class ObservableFiniteStateMachine<
 ### SparseSet
 ```ts
 class SparseSet {
-  get [Symbol.iterator](): Iterable<number>
+  get [Symbol.toStringTag](): string
+  get [Symbol.iterator](): IterableIterator<number>
 
   add(value: number): void
   has(value: number): boolean
   remove(value: number): void
 }
 ```
+
+### DynamicTypedArray
+```ts
+class DynamicTypedArray<T extends TypedArrayConstructor> {
+  get [Symbol.toStringTag](): string
+  get capacity(): number
+  get length(): number
+
+  /**
+   * Note that `DynamicTypedArray` cannot respond to any operations on the internal array,
+   * you must ensure that indexes accessed are less than the length of `DynamicTypedArray`.
+   */
+  get internalTypedArray(): TypedArrayOfConstructor<T>
+
+  constructor(
+    typedArrayConstructor: T
+  , options: {
+      capacity?: number = 0
+      growthFactor?: number = 1.5
+    } = {}
+  )
+
+  set(index: number, value: number): void
+  get(index: number): number | undefined
+  push(...values: number[]): void
+  pop(): number | undefined
+}
+```