vivth 1.3.2 → 1.3.4

package/types/src/function/GetNamedImportAlias.d.mts

@@ -0,0 +1,22 @@
+/**
+ * @description
+ * - regex helper for:
+ * >- get named import; OR
+ * >- alias of named import;
+ * @param {string} content
+ * @param {string} moduleName
+ * @param {string} packageName
+ * @returns {string|undefined}
+ * @example
+ * import { GetNamedImportAlias } from 'vivth';
+ *
+ * const checkNoAlias = `
+ * import { something } from 'packageName';
+ * `
+ * const checkAlias = `
+ * import { something as somethingElse } from 'packageName';
+ * `
+ * GetNamedImportAlias(checkNoAlias, 'something', 'packageName'); // 'something'
+ * GetNamedImportAlias(checkAlias, 'something', 'packageName'); // 'somethingElse'
+ */
+export function GetNamedImportAlias(content: string, moduleName: string, packageName: string): string | undefined;

package/types/src/function/LazyFactory.d.mts

@@ -29,7 +29,7 @@
  * const a = myInstance; // not yet initiated;
  * const b = a.myProp // imediately initiated;
  * // OR
- * myInstance["vivth:unwrapLazy;"]() // forcefully call the callback;
+ * myInstance["vivth:unwrapLazy;"]() // forcefully call factory generator;
  */
 export function LazyFactory<FACTORY>(factory: () => FACTORY): FACTORY & {
     [unwrapLazy]: () => FACTORY;

package/types/src/function/TsToMjs.d.mts

@@ -1,8 +1,8 @@
 /**
  * @description
- * - turn `.mts`||`.ts` file into `.mjs`, no bundling, just translation;
+ * - turn `.mts`||`.ts` file into `.mjs`, no bundling, just traspilation;
  * - on certain circumstance where `.mjs` result needed to be typed, you need to manually add `jsdoc`;
- * >- uses `"at"preserve` to register `jsdoc` inline;
+ * >- uses `"at"preserve` to register `jsdoc`;
  * @param {string} path_
  * - path from `Paths.root`;
  * @param {Object} [options]
@@ -15,7 +15,7 @@
  * @example
  * import { TsToMjs } from 'vivth';
  *
- * TsToMjs('./myFile.mts', { encoding: 'utf-8', overrideDir: './other/dir' });
+ * await TsToMjs('./myFile.mts', { encoding: 'utf-8', overrideDir: './other/dir' });
  */
 export function TsToMjs(path_: string, { overrideDir, encoding }?: {
     overrideDir?: string | undefined;

package/types/src/function/WithDefer.d.mts

@@ -0,0 +1,10 @@
+/**
+ * Description
+ * @param {(
+ * this:{defer:(tobeDefered:()=>Promise<void>)=>void}
+ * )=>Promise<void>} cb
+ * @returns {void}
+ */
+export function WithDefer(cb: (this: {
+    defer: (tobeDefered: () => Promise<void>) => void;
+}) => Promise<void>): void;

package/types/src/types/DevTestCB.d.mts

@@ -0,0 +1,3 @@
+export type DevTestCB = (testName: string, testCallback: () => Promise<boolean>) => Promise<{
+    removeId: () => void;
+}>;

package/types/src/types/IsDevCBStringType.d.mts

@@ -0,0 +1,4 @@
+/**
+ * - closing helper for `Dev.IsDevCB`;
+ */
+export type IsDevCBStringType = "IsDevCB";

package/types/src/types/Runtime.d.mts

@@ -1 +1,4 @@
+/**
+ * - for popular runtimes check;
+ */
 export type Runtime = "node" | "bun" | "deno" | "browser" | "unknown";

package/types/src/types/VivthDevCodeBlockStringType.d.mts

@@ -0,0 +1,4 @@
+/**
+ * - closing helper for `Dev.vivthDevCodeBlock`;
+ */
+export type VivthDevCodeBlockStringType = "vivthDevCodeBlock";