@dr.pogodin/js-utils 0.0.3 → 0.0.5

package/README.md

@@ -6,6 +6,7 @@
 [![NPM Downloads](https://img.shields.io/npm/dm/@dr.pogodin/js-utils.svg)](https://www.npmjs.com/package/@dr.pogodin/js-utils)
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/birdofpreyru/js-utils/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/birdofpreyru/js-utils)
 [![GitHub repo stars](https://img.shields.io/github/stars/birdofpreyru/js-utils?style=social)](https://github.com/birdofpreyru/js-utils)
+[![Dr. Pogodin Studio](https://raw.githubusercontent.com/birdofpreyru/js-utils/master/.README/logo-dr-pogodin-studio.png)](https://dr.pogodin.studio/docs/js-utils)
 
 The aim for this repo/package is to move in from the [React Utils] the pieces
 which are not React-specific, thus are also useful cross non-React projects,
@@ -25,3 +26,39 @@ Consumers of that NPM package thus will have access to both TS (`/ts` folder)
 and JS (`/js` folder) version of the library.
 
 [![Sponsor](.README/sponsor.png)](https://github.com/sponsors/birdofpreyru)
+
+## Content
+
+The library currently exports (links below lead to [React Utils] docs,
+but the same stuff can be imported from this `@dr.pogodin/js-utils`,
+and used in the same way):
+
+[Barrier]: https://dr.pogodin.studio/docs/react-utils/docs/api/classes/Barrier
+[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[timer]: https://dr.pogodin.studio/docs/react-utils/docs/api/utils/time#timer
+
+### Constants
+- [SEC_MS](https://dr.pogodin.studio/docs/react-utils/docs/api/utils/time#sec_ms)
+  — One second expressed in milliseconds.
+- [MIN_MS](https://dr.pogodin.studio/docs/react-utils/docs/api/utils/time#min_ms)
+  — One minute expressed in milliseconds.
+- [HOUR_MS](https://dr.pogodin.studio/docs/react-utils/docs/api/utils/time#hour_ms)
+  — One hour expressed in milliseconds.
+- [DAY_MS](https://dr.pogodin.studio/docs/react-utils/docs/api/utils/time#day_ms)
+  — One day expressed in milliseconds.
+- [YEAR_MS](https://dr.pogodin.studio/docs/react-utils/docs/api/utils/time#year_ms)
+  — One year expressed in milliseconds.
+
+### Functions
+- [timer]
+  — Creates a [Barrier] which resolves after the specified timeout.
+
+### Classes
+- [Barrier] — A [Promise] with **resolve()** and **reject()** exposed as
+  instance methods.
+- [Emitter](https://dr.pogodin.studio/docs/react-utils/docs/api/classes/Emitter)
+  — Simple listeneable data emitter.
+- [Semaphore](https://dr.pogodin.studio/docs/react-utils/docs/api/classes/Semaphore)
+  — Synchronization primitive.
+- `Timer` — The core implementation of [timer] functionality, allowing
+  to create further customized timer objects. _To be documented_.

package/js/Barrier.d.ts

@@ -7,7 +7,7 @@ export type Executor<T> = (resolve: Resolver<T>, reject: Rejecter) => void;
  *
  * Docs: https://dr.pogodin.studio/docs/react-utils/docs/api/classes/Barrier
  */
-export default class Barrier<T, TR = T> extends Promise<TR> {
+export default class Barrier<T = unknown, TR = T> extends Promise<TR> {
     private p_resolve;
     private p_reject;
     private p_state;

package/js/Emitter.d.ts

@@ -1,30 +1,34 @@
-type Listener = (...args: any[]) => void;
+type Listener<T extends unknown[] = unknown[]> = (...args: T) => void;
 /**
  * Simple listeneable data Emitter.
  */
-export default class Emitter {
+export default class Emitter<T extends unknown[] = unknown[]> {
     private p_listeners;
     /**
      * Returns "true" if any listener is connected; "false" otherwise.
      * @return {boolean}
      */
     get hasListeners(): boolean;
-    get listeners(): ReadonlyArray<Listener>;
+    get listeners(): ReadonlyArray<Listener<T>>;
     /**
      * Adds `listener` if it is not already connected.
      * @param {function} listener
      * @return {function} Unsubscribe function.
      */
-    addListener(listener: Listener): () => void;
+    addListener(listener: Listener<T>): () => void;
     /**
      * Calls every connected listener with the given arguments.
-     * @param  {...any} args
+     * @param args
      */
-    emit(...args: any[]): void;
+    emit(...args: T): void;
+    /**
+     * Removes all connected listeners.
+     */
+    removeAllListeners(): void;
     /**
      * Removes specified `listener`, if connected.
-     * @param {function} listener
+     * @param listener
      */
-    removeListener(listener: Listener): void;
+    removeListener(listener: Listener<T>): void;
 }
 export {};

package/js/Emitter.js

@@ -28,7 +28,7 @@ class Emitter {
     }
     /**
      * Calls every connected listener with the given arguments.
-     * @param  {...any} args
+     * @param args
      */
     emit(...args) {
         const { p_listeners: listeners } = this;
@@ -36,9 +36,15 @@ class Emitter {
             listeners[i](...args);
         }
     }
+    /**
+     * Removes all connected listeners.
+     */
+    removeAllListeners() {
+        this.p_listeners = [];
+    }
     /**
      * Removes specified `listener`, if connected.
-     * @param {function} listener
+     * @param listener
      */
     removeListener(listener) {
         const idx = this.p_listeners.indexOf(listener);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dr.pogodin/js-utils",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Collection of JavaScript (TypeScript) utilities.",
   "main": "js/index",
   "react-native": "ts/index",
@@ -29,15 +29,15 @@
   },
   "homepage": "https://github.com/birdofpreyru/js-utils#readme",
   "devDependencies": {
-    "@babel/core": "^7.21.4",
-    "@babel/preset-env": "^7.21.4",
-    "@babel/preset-typescript": "^7.21.4",
+    "@babel/core": "^7.21.8",
+    "@babel/preset-env": "^7.21.5",
+    "@babel/preset-typescript": "^7.21.5",
     "@tsconfig/recommended": "^1.0.2",
     "@types/jest": "^29.5.1",
-    "@typescript-eslint/eslint-plugin": "^5.59.1",
-    "@typescript-eslint/parser": "^5.59.1",
+    "@typescript-eslint/eslint-plugin": "^5.59.6",
+    "@typescript-eslint/parser": "^5.59.6",
     "babel-jest": "^29.5.0",
-    "eslint": "^8.39.0",
+    "eslint": "^8.40.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-import-resolver-typescript": "^3.5.5",

package/ts/Barrier.ts

@@ -14,7 +14,7 @@ enum STATE {
  *
  * Docs: https://dr.pogodin.studio/docs/react-utils/docs/api/classes/Barrier
  */
-export default class Barrier<T, TR = T> extends Promise<TR> {
+export default class Barrier<T = unknown, TR = T> extends Promise<TR> {
   private p_resolve: Resolver<T> | Resolver<TR>;
 
   private p_reject: Rejecter;

package/ts/Emitter.ts

@@ -1,10 +1,10 @@
-type Listener = (...args: any[]) => void;
+type Listener<T extends unknown[] = unknown[]> = (...args: T) => void;
 
 /**
  * Simple listeneable data Emitter.
  */
-export default class Emitter {
-  private p_listeners: Listener[] = [];
+export default class Emitter<T extends unknown[] = unknown[]> {
+  private p_listeners: Listener<T>[] = [];
 
   /**
    * Returns "true" if any listener is connected; "false" otherwise.
@@ -14,14 +14,14 @@ export default class Emitter {
     return !!this.p_listeners.length;
   }
 
-  get listeners(): ReadonlyArray<Listener> { return this.p_listeners; }
+  get listeners(): ReadonlyArray<Listener<T>> { return this.p_listeners; }
 
   /**
    * Adds `listener` if it is not already connected.
    * @param {function} listener
    * @return {function} Unsubscribe function.
    */
-  addListener(listener: Listener): () => void {
+  addListener(listener: Listener<T>): () => void {
     if (!this.p_listeners.includes(listener)) {
       this.p_listeners.push(listener);
     }
@@ -30,20 +30,27 @@ export default class Emitter {
 
   /**
    * Calls every connected listener with the given arguments.
-   * @param  {...any} args
+   * @param args
    */
-  emit(...args: any[]) {
+  emit(...args: T) {
     const { p_listeners: listeners } = this;
     for (let i = 0; i < listeners.length; ++i) {
       listeners[i](...args);
     }
   }
 
+  /**
+   * Removes all connected listeners.
+   */
+  removeAllListeners() {
+    this.p_listeners = [];
+  }
+
   /**
    * Removes specified `listener`, if connected.
-   * @param {function} listener
+   * @param listener
    */
-  removeListener(listener: Listener) {
+  removeListener(listener: Listener<T>) {
     const idx = this.p_listeners.indexOf(listener);
     if (idx >= 0) this.p_listeners.splice(idx, 1);
   }