@thi.ng/api 8.8.2 → 8.9.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-06-14T07:58:51Z
+- **Last updated**: 2023-08-04T10:58:19Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,15 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [8.9.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/api@8.9.0) (2023-08-04)
+
+#### 🚀 Features
+
+- add generics for Event & INotify ([7702882](https://github.com/thi-ng/umbrella/commit/7702882))
+- add basic utility functions: identity, always, never ([4801e2d](https://github.com/thi-ng/umbrella/commit/4801e2d))
+- add generics for INotify, Event, Listener types ([dd0a6ed](https://github.com/thi-ng/umbrella/commit/dd0a6ed))
+- add IIDGen interface ([26cf9d1](https://github.com/thi-ng/umbrella/commit/26cf9d1))
+
 ## [8.8.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/api@8.8.0) (2023-04-19)
 
 #### 🚀 Features

package/README.md

@@ -55,7 +55,7 @@ For Node.js REPL:
 const api = await import("@thi.ng/api");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.36 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.39 KB
 
 ## Dependencies
 

package/event.d.ts

@@ -1,10 +1,13 @@
 import type { Fn } from "./fn.js";
 import type { IID } from "./id.js";
 /**
- * Event listener.
+ * Event listener for {@link Event}.
  */
-export type Listener = Fn<Event, void>;
-export interface Event extends IID<PropertyKey> {
+export type Listener<T extends string = string> = Fn<Event<T>, void>;
+/**
+ * Event type used in combination with {@link INotify}.
+ */
+export interface Event<T extends string = string> extends IID<T> {
     target?: any;
     canceled?: boolean;
     value?: any;
@@ -12,10 +15,12 @@ export interface Event extends IID<PropertyKey> {
 /**
  * Interface to provide event emitter functionality. Also see
  * {@link INotifyMixin} decorator mixin.
+ *
+ * The type param `T` can be used to constrain the event type/id.
  */
-export interface INotify {
-    addListener(id: string, fn: Listener, scope?: any): boolean;
-    removeListener(id: string, fn: Listener, scope?: any): boolean;
+export interface INotify<T extends string = string> {
+    addListener(id: T, fn: Listener<T>, scope?: any): boolean;
+    removeListener(id: T, fn: Listener<T>, scope?: any): boolean;
     /**
      * Broadcasts all registered listeners for given event type (in order
      * registration) and returns true if any of them have been successfully
@@ -29,6 +34,6 @@ export interface INotify {
      *
      * @param event
      */
-    notify(event: Event): boolean;
+    notify(event: Event<T>): boolean;
 }
 //# sourceMappingURL=event.d.ts.map

package/fn.d.ts

@@ -120,4 +120,18 @@ export type FnN7 = FnU7<number>;
 export type FnN8 = FnU8<number>;
 export type FnN9 = FnU9<number>;
 export type FnN10 = FnU10<number>;
+/**
+ * Identity function: `(x) => x`
+ *
+ * @param x
+ */
+export declare const identity: <T>(x: T) => T;
+/**
+ * Zero-arg function always returning true.
+ */
+export declare const always: () => boolean;
+/**
+ * Zero-arg function always returning false.
+ */
+export declare const never: () => boolean;
 //# sourceMappingURL=fn.d.ts.map

package/fn.js

@@ -1 +1,14 @@
-export {};
+/**
+ * Identity function: `(x) => x`
+ *
+ * @param x
+ */
+export const identity = (x) => x;
+/**
+ * Zero-arg function always returning true.
+ */
+export const always = () => true;
+/**
+ * Zero-arg function always returning false.
+ */
+export const never = () => false;

package/id.d.ts

@@ -4,4 +4,20 @@
 export interface IID<T> {
     readonly id: T;
 }
+/**
+ * Common minimal base interface for ID generators.
+ */
+export interface IIDGen<T> {
+    /**
+     * Returns next available ID (or throws an error if none available).
+     */
+    next(): T;
+    /**
+     * Releases given ID (to be called when ID isn't needed anymore). Actual
+     * behavior is implementation specific.
+     *
+     * @param id
+     */
+    free(id: T): boolean;
+}
 //# sourceMappingURL=id.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/api",
-  "version": "8.8.2",
+  "version": "8.9.0",
   "description": "Common, generic types, interfaces & mixins",
   "type": "module",
   "module": "./index.js",
@@ -37,12 +37,12 @@
     "test": "testament test"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.35.3",
-    "@thi.ng/testament": "^0.3.17",
+    "@microsoft/api-extractor": "^7.36.3",
+    "@thi.ng/testament": "^0.3.18",
     "rimraf": "^5.0.1",
     "tools": "^0.0.1",
     "typedoc": "^0.24.8",
-    "typescript": "^5.1.3"
+    "typescript": "^5.1.6"
   },
   "keywords": [
     "assert",
@@ -225,5 +225,5 @@
       "default": "./watch.js"
     }
   },
-  "gitHead": "54e825a976c72067a244cff8725ca98f5416d26d\n"
+  "gitHead": "9fa3f7f8169efa30e3c71b43c82f77393581c3b5\n"
 }