vivth 1.1.0 → 1.1.1

package/README.md

@@ -68,12 +68,12 @@ npm i vivth
  - [TsToMjs](#tstomjs)
  - [WriteFileSafe](#writefilesafe)
  - [AnyButUndefined](#anybutundefined)
- - [ExtnameType](#extnametype)
- - [IsListSignal](#islistsignal)
- - [ListArg](#listarg)
- - [MutationType](#mutationtype)
- - [QCBFIFOReturn](#qcbfiforeturn)
  - [QCBReturn](#qcbreturn)
+ - [QCBFIFOReturn](#qcbfiforeturn)
+ - [MutationType](#mutationtype)
+ - [ListArg](#listarg)
+ - [IsListSignal](#islistsignal)
+ - [ExtnameType](#extnametype)
 
 <h2 id="compilemjs">CompileMJS</h2>
 
@@ -1031,7 +1031,7 @@ npm i vivth
 
 ```js
 /**
- * @template {[string, ...string[]]} ExitEventNames
+ * @template {[string, ...string[]]} eventNames
  */
 ```
 
@@ -1050,8 +1050,8 @@ npm i vivth
 ```js
 /**
  * @param {Object} options 	 
- * @param {ExitEventNames} options.exitEventNames 	 
- * @param {()=>void} options.exitCallback 	 
+ * @param {eventNames} options.eventNames 	 
+ * @param {()=>void} options.terminator 	 
  * - standard node/bun: 	 
  * ```js 	 
  * () => process.exit(0), 	 
@@ -1060,7 +1060,7 @@ npm i vivth
  * ```js 	 
  * () => Deno.exit(0), 	 
  * ``` 	 
- * @param {(eventName:string)=>void} [options.exitCallbackListeners] 	 
+ * @param {(eventName:string)=>void} [options.listener] 	 
  * - default value 	 
  * ```js 	 
  * (eventName) => { 	 
@@ -1078,12 +1078,12 @@ npm i vivth
  import { SafeExit, Console } from 'vivth'; 	 
  	 
  new SafeExit({ 	 
- 	// exitEventNames are blank by default, you need to manually name them all; 	 
+ 	// eventNames are blank by default, you need to manually name them all; 	 
  	// 'exit' will be omited, as it might cause async callbacks failed to execute; 	 
- 	exitEventNames: ['SIGINT', 'SIGTERM', ...otherExitEventNames], 	 
- 	exitCallback = () => process.exit(0), // OR on deno () => Deno.exit(0), 	 
+ 	eventNames: ['SIGINT', 'SIGTERM', ...eventNames], 	 
+ 	terminator = () => process.exit(0), // OR on deno () => Deno.exit(0), 	 
  	// optional deno example 	 
- 	exitCallbackListeners = (eventName) => { 	 
+ 	listener = (eventName) => { 	 
  		const sig = Deno.signal(eventName); 	 
  			for await (const _ of sig) { 	 
  				exiting.correction(true); 	 
@@ -2134,76 +2134,76 @@ npm i vivth
 ```
 *) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
 
-<h2 id="extnametype">ExtnameType</h2>
+<h2 id="qcbreturn">QCBReturn</h2>
 
 - jsdoc types:
 
 ```js
 /**
- * - jsRuntime extention naming convention;
- * @typedef {`.${string}`} ExtnameType
+ * - return type of Q callback;
+ * @typedef {{resume:()=>void, isLastOnQ:boolean}} QCBReturn
  */
 ```
 *) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
 
-<h2 id="islistsignal">IsListSignal</h2>
+<h2 id="qcbfiforeturn">QCBFIFOReturn</h2>
 
 - jsdoc types:
 
 ```js
 /**
- * - `EnvSignal.get` argument whether signal need to be a list or not;
- * @typedef {boolean} IsListSignal
+ * - return type of Q callback fifo;
+ * @typedef {Omit<import("./src/types/QCBReturn.mjs").QCBReturn, "isLastOnQ">} QCBFIFOReturn
  */
 ```
 *) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
 
-<h2 id="listarg">ListArg</h2>
+<h2 id="mutationtype">MutationType</h2>
 
 - jsdoc types:
 
 ```js
 /**
- * - ListSignal argument type;
- * @typedef {Record<string, string>} ListArg
+ * - `ListSignal` mutation type;
+ * @typedef {'push'|'unshift'|'splice'|'swap'|'modify'|'shift'|'remove'} MutationType
+ * - instance method: serves as helper to mutate, and notify for `effects`;
+ * > - `slice` uses `splice` in the background, you don't need to manually reindex when using it;
  */
 ```
 *) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
 
-<h2 id="mutationtype">MutationType</h2>
+<h2 id="listarg">ListArg</h2>
 
 - jsdoc types:
 
 ```js
 /**
- * - `ListSignal` mutation type;
- * @typedef {'push'|'unshift'|'splice'|'swap'|'modify'|'shift'|'remove'} MutationType
- * - instance method: serves as helper to mutate, and notify for `effects`;
- * > - `slice` uses `splice` in the background, you don't need to manually reindex when using it;
+ * - ListSignal argument type;
+ * @typedef {Record<string, string>} ListArg
  */
 ```
 *) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
 
-<h2 id="qcbfiforeturn">QCBFIFOReturn</h2>
+<h2 id="islistsignal">IsListSignal</h2>
 
 - jsdoc types:
 
 ```js
 /**
- * - return type of Q callback fifo;
- * @typedef {Omit<import("./src/types/QCBReturn.mjs").QCBReturn, "isLastOnQ">} QCBFIFOReturn
+ * - `EnvSignal.get` argument whether signal need to be a list or not;
+ * @typedef {boolean} IsListSignal
  */
 ```
 *) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
 
-<h2 id="qcbreturn">QCBReturn</h2>
+<h2 id="extnametype">ExtnameType</h2>
 
 - jsdoc types:
 
 ```js
 /**
- * - return type of Q callback;
- * @typedef {{resume:()=>void, isLastOnQ:boolean}} QCBReturn
+ * - jsRuntime extention naming convention;
+ * @typedef {`.${string}`} ExtnameType
  */
 ```
 *) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>

package/dev/index.mjs

@@ -11,9 +11,9 @@ new paths({
 });
 
 new safeExit({
-	exitEventNames: ['SIGINT', 'SIGTERM', 'exit'],
-	exitCallback: () => process.exit(0),
-	exitCallbackListeners: (eventName) => {
+	eventNames: ['SIGINT', 'SIGTERM', 'exit'],
+	terminator: () => process.exit(0),
+	listener: (eventName) => {
 		process.once(eventName, function () {
 			safeExit.instance.exiting.correction(true);
 			Console.log(`safe exit via "${eventName}"`);

package/index.mjs

@@ -41,20 +41,20 @@ export { WriteFileSafe } from './src/function/WriteFileSafe.mjs';
  * @typedef {import('./src/types/AnyButUndefined.mjs').AnyButUndefined} AnyButUndefined
  */
 /**
- * @typedef {import('./src/types/ExtnameType.mjs').ExtnameType} ExtnameType
+ * @typedef {import('./src/types/QCBReturn.mjs').QCBReturn} QCBReturn
  */
 /**
- * @typedef {import('./src/types/IsListSignal.mjs').IsListSignal} IsListSignal
+ * @typedef {import('./src/types/QCBFIFOReturn.mjs').QCBFIFOReturn} QCBFIFOReturn
  */
 /**
- * @typedef {import('./src/types/ListArg.mjs').ListArg} ListArg
+ * @typedef {import('./src/types/MutationType.mjs').MutationType} MutationType
  */
 /**
- * @typedef {import('./src/types/MutationType.mjs').MutationType} MutationType
+ * @typedef {import('./src/types/ListArg.mjs').ListArg} ListArg
  */
 /**
- * @typedef {import('./src/types/QCBFIFOReturn.mjs').QCBFIFOReturn} QCBFIFOReturn
+ * @typedef {import('./src/types/IsListSignal.mjs').IsListSignal} IsListSignal
  */
 /**
- * @typedef {import('./src/types/QCBReturn.mjs').QCBReturn} QCBReturn
+ * @typedef {import('./src/types/ExtnameType.mjs').ExtnameType} ExtnameType
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vivth",
-	"version": "1.1.0",
+	"version": "1.1.1",
 	"description": "extremely simple signal as library primitives",
 	"main": "index.mjs",
 	"types": "./types/index.d.mts",

package/src/class/SafeExit.mjs

@@ -15,7 +15,7 @@ export const safeCleanUpCBs = new Set();
  * @description
  * - class helper for describing how to Safely Response on exit events
  * - singleton;
- * @template {[string, ...string[]]} ExitEventNames
+ * @template {[string, ...string[]]} eventNames
  */
 export class SafeExit {
 	/**
@@ -27,8 +27,8 @@ export class SafeExit {
 	/**
 	 * @description
 	 * @param {Object} options
-	 * @param {ExitEventNames} options.exitEventNames
-	 * @param {()=>void} options.exitCallback
+	 * @param {eventNames} options.eventNames
+	 * @param {()=>void} options.terminator
 	 * - standard node/bun:
 	 * ```js
 	 * () => process.exit(0),
@@ -37,7 +37,7 @@ export class SafeExit {
 	 * ```js
 	 * () => Deno.exit(0),
 	 * ```
-	 * @param {(eventName:string)=>void} [options.exitCallbackListeners]
+	 * @param {(eventName:string)=>void} [options.listener]
 	 * - default value
 	 * ```js
 	 * (eventName) => {
@@ -52,12 +52,12 @@ export class SafeExit {
 	 * import { SafeExit, Console } from 'vivth';
 	 *
 	 * new SafeExit({
-	 * 	// exitEventNames are blank by default, you need to manually name them all;
+	 * 	// eventNames are blank by default, you need to manually name them all;
 	 * 	// 'exit' will be omited, as it might cause async callbacks failed to execute;
-	 * 	exitEventNames: ['SIGINT', 'SIGTERM', ...otherExitEventNames],
-	 * 	exitCallback = () => process.exit(0), // OR on deno () => Deno.exit(0),
+	 * 	eventNames: ['SIGINT', 'SIGTERM', ...eventNames],
+	 * 	terminator = () => process.exit(0), // OR on deno () => Deno.exit(0),
 	 * 	// optional deno example
-	 * 	exitCallbackListeners = (eventName) => {
+	 * 	listener = (eventName) => {
 	 * 		const sig = Deno.signal(eventName);
 	 * 			for await (const _ of sig) {
 	 * 				exiting.correction(true);
@@ -67,16 +67,16 @@ export class SafeExit {
 	 * 	}
 	 * });
 	 */
-	constructor({ exitEventNames, exitCallback, exitCallbackListeners = undefined }) {
+	constructor({ eventNames, terminator, listener = undefined }) {
 		if (SafeExit.instance) {
 			return SafeExit.instance;
 		}
 		SafeExit.instance = this;
-		this.#exit = exitCallback;
-		if (exitCallbackListeners) {
-			this.#exitCallbackListeners = exitCallbackListeners;
+		this.#exit = terminator;
+		if (listener) {
+			this.#listener = listener;
 		}
-		this.#register(exitEventNames);
+		this.#register(eventNames);
 	}
 	/**
 	 * @description
@@ -86,21 +86,21 @@ export class SafeExit {
 	 */
 	exiting = new EnvSignal(false);
 	/**
-	 * @param {ExitEventNames} exitEventNames
+	 * @param {eventNames} eventNames
 	 * @returns {void}
 	 */
-	#register = (exitEventNames) => {
-		exitEventNames.forEach((eventName) => {
+	#register = (eventNames) => {
+		eventNames.forEach((eventName) => {
 			if (eventName == 'exit') {
 				return;
 			}
-			this.#exitCallbackListeners(eventName);
+			this.#listener(eventName);
 		});
 	};
 	/**
 	 * @type {(eventName:string)=>void}
 	 */
-	#exitCallbackListeners = (eventName) => {
+	#listener = (eventName) => {
 		SafeExit.instance.exiting.env.value;
 		process.once(eventName, function () {
 			Console.log(`safe exit via "${eventName}"`);

package/types/index.d.mts

@@ -30,9 +30,9 @@ export { TrySync } from "./src/function/TrySync.mjs";
 export { TsToMjs } from "./src/function/TsToMjs.mjs";
 export { WriteFileSafe } from "./src/function/WriteFileSafe.mjs";
 export type AnyButUndefined = import("./src/types/AnyButUndefined.mjs").AnyButUndefined;
-export type ExtnameType = import("./src/types/ExtnameType.mjs").ExtnameType;
-export type IsListSignal = import("./src/types/IsListSignal.mjs").IsListSignal;
-export type ListArg = import("./src/types/ListArg.mjs").ListArg;
-export type MutationType = import("./src/types/MutationType.mjs").MutationType;
-export type QCBFIFOReturn = import("./src/types/QCBFIFOReturn.mjs").QCBFIFOReturn;
 export type QCBReturn = import("./src/types/QCBReturn.mjs").QCBReturn;
+export type QCBFIFOReturn = import("./src/types/QCBFIFOReturn.mjs").QCBFIFOReturn;
+export type MutationType = import("./src/types/MutationType.mjs").MutationType;
+export type ListArg = import("./src/types/ListArg.mjs").ListArg;
+export type IsListSignal = import("./src/types/IsListSignal.mjs").IsListSignal;
+export type ExtnameType = import("./src/types/ExtnameType.mjs").ExtnameType;

package/types/src/class/SafeExit.d.mts

@@ -6,9 +6,9 @@ export const safeCleanUpCBs: Set<() => Promise<void>>;
  * @description
  * - class helper for describing how to Safely Response on exit events
  * - singleton;
- * @template {[string, ...string[]]} ExitEventNames
+ * @template {[string, ...string[]]} eventNames
  */
-export class SafeExit<ExitEventNames extends [string, ...string[]]> {
+export class SafeExit<eventNames extends [string, ...string[]]> {
     /**
      * @description
      * - only accessible after instantiation;
@@ -18,8 +18,8 @@ export class SafeExit<ExitEventNames extends [string, ...string[]]> {
     /**
      * @description
      * @param {Object} options
-     * @param {ExitEventNames} options.exitEventNames
-     * @param {()=>void} options.exitCallback
+     * @param {eventNames} options.eventNames
+     * @param {()=>void} options.terminator
      * - standard node/bun:
      * ```js
      * () => process.exit(0),
@@ -28,7 +28,7 @@ export class SafeExit<ExitEventNames extends [string, ...string[]]> {
      * ```js
      * () => Deno.exit(0),
      * ```
-     * @param {(eventName:string)=>void} [options.exitCallbackListeners]
+     * @param {(eventName:string)=>void} [options.listener]
      * - default value
      * ```js
      * (eventName) => {
@@ -43,12 +43,12 @@ export class SafeExit<ExitEventNames extends [string, ...string[]]> {
      * import { SafeExit, Console } from 'vivth';
      *
      * new SafeExit({
-     * 	// exitEventNames are blank by default, you need to manually name them all;
+     * 	// eventNames are blank by default, you need to manually name them all;
      * 	// 'exit' will be omited, as it might cause async callbacks failed to execute;
-     * 	exitEventNames: ['SIGINT', 'SIGTERM', ...otherExitEventNames],
-     * 	exitCallback = () => process.exit(0), // OR on deno () => Deno.exit(0),
+     * 	eventNames: ['SIGINT', 'SIGTERM', ...eventNames],
+     * 	terminator = () => process.exit(0), // OR on deno () => Deno.exit(0),
      * 	// optional deno example
-     * 	exitCallbackListeners = (eventName) => {
+     * 	listener = (eventName) => {
      * 		const sig = Deno.signal(eventName);
      * 			for await (const _ of sig) {
      * 				exiting.correction(true);
@@ -58,10 +58,10 @@ export class SafeExit<ExitEventNames extends [string, ...string[]]> {
      * 	}
      * });
      */
-    constructor({ exitEventNames, exitCallback, exitCallbackListeners }: {
-        exitEventNames: ExitEventNames;
-        exitCallback: () => void;
-        exitCallbackListeners?: (eventName: string) => void;
+    constructor({ eventNames, terminator, listener }: {
+        eventNames: eventNames;
+        terminator: () => void;
+        listener?: (eventName: string) => void;
     });
     /**
      * @description