typeshi 1.3.0 → 1.5.0

package/dist/utils/argumentValidation.d.ts

@@ -11,7 +11,6 @@
  * - or maybe have them return boolean type predicates ?
  * - -> maybe have to make a class
  * - research the thingy where a type is after the function name and before parens
- * @consideration add a default export named 'validate'
  */
 import { TypeOfEnum } from "./typeValidation";
 /**
@@ -192,4 +191,19 @@ export declare function existingPathArgument(source: string, arg2: string | {
  * @returns **`bracketedString`** `string`
  */
 export declare const bracketed: (s: string) => string;
-export {};
+declare const validate: {
+    stringArgument: typeof stringArgument;
+    multipleStringArguments: typeof multipleStringArguments;
+    numericStringArgument: typeof numericStringArgument;
+    booleanArgument: typeof booleanArgument;
+    numberArgument: typeof numberArgument;
+    arrayArgument: typeof arrayArgument;
+    enumArgument: typeof enumArgument;
+    objectArgument: typeof objectArgument;
+    functionArgument: typeof functionArgument;
+    existingPathArgument: typeof existingPathArgument;
+    existingDirectoryArgument: typeof existingDirectoryArgument;
+    existingFileArgument: typeof existingFileArgument;
+    multipleExistingFileArguments: typeof multipleExistingFileArguments;
+};
+export default validate;

package/dist/utils/argumentValidation.js

@@ -63,7 +63,6 @@ exports.existingPathArgument = existingPathArgument;
  * - or maybe have them return boolean type predicates ?
  * - -> maybe have to make a class
  * - research the thingy where a type is after the function name and before parens
- * @consideration add a default export named 'validate'
  */
 const typeValidation_1 = require("./typeValidation");
 const setupLog_1 = require("../config/setupLog");
@@ -315,6 +314,9 @@ function functionArgument(source, arg2, value) {
         throw new Error(msg);
     }
 }
+/**
+ * `re = /(?<=^is).*$/i`
+ */
 const typeGuardNamePattern = /(?<=^is).*$/i;
 /**
  * @note `if` `elementTypeGuard`'s name or its label includes 'Array' then only check `elementTypeGuard(value)`
@@ -808,3 +810,22 @@ function getSourceString(fileName, func, funcInfo, startLine, endLine) {
     let funcName = typeof func === 'string' ? func : func.name;
     return `[${fileName}.${funcName}(${(0, typeValidation_1.isNonEmptyString)(funcInfo) ? ` ${funcInfo} ` : ''})${lineNumberText}]`;
 }
+const validate = {
+    stringArgument,
+    multipleStringArguments,
+    numericStringArgument,
+    booleanArgument,
+    numberArgument,
+    arrayArgument,
+    enumArgument,
+    // isEnumArgumentOptions,
+    // isEnumObject,
+    objectArgument,
+    // isObjectArgumentOptions,
+    functionArgument,
+    existingPathArgument,
+    existingDirectoryArgument,
+    existingFileArgument,
+    multipleExistingFileArguments
+};
+exports.default = validate;

package/dist/utils/io/dateTime.d.ts

@@ -94,3 +94,26 @@ export declare function getCurrentPacificTime(): string;
  * @returns {string} The date string in Pacific Time
  */
 export declare function toPacificTime(initialDateString: string): string;
+export declare const Milliseconds: {
+    from: {
+        hours: (n: number) => number;
+        minutes: (n: number) => number;
+        seconds: (n: number) => number;
+        /**
+         * @param d `Date` object
+         * @returns `number` milliseconds since epoch
+         */
+        date: (d: Date) => number;
+    };
+    to: {
+        hours: (n: number) => number;
+        minutes: (n: number) => number;
+        seconds: (n: number) => number;
+        /**
+         * interprets `n` as milliseconds since epoch
+         * @param n `number` milliseconds
+         * @returns `Date` object
+         */
+        date: (n: number) => Date;
+    };
+};

package/dist/utils/io/dateTime.js

@@ -3,7 +3,7 @@
  * @file src/utils/io/dateTime.ts
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_TIMEZONE = exports.DEFAULT_LOCALE = exports.ISO_PATTERN = exports.TimeUnitEnum = exports.DateFormatEnum = void 0;
+exports.Milliseconds = exports.DEFAULT_TIMEZONE = exports.DEFAULT_LOCALE = exports.ISO_PATTERN = exports.TimeUnitEnum = exports.DateFormatEnum = void 0;
 exports.getDateFromUnixTimestamp = getDateFromUnixTimestamp;
 exports.calculateDifferenceOfDateStrings = calculateDifferenceOfDateStrings;
 exports.getUnixTimestampFromISO = getUnixTimestampFromISO;
@@ -200,3 +200,42 @@ function toPacificTime(initialDateString) {
     const pacificTime = initialDate.toLocaleString(exports.DEFAULT_LOCALE, { timeZone: exports.DEFAULT_TIMEZONE });
     return pacificTime;
 }
+exports.Milliseconds = {
+    from: {
+        hours: (n) => {
+            return n * (1000 * 60 * 60);
+        },
+        minutes: (n) => {
+            return n * (1000 * 60);
+        },
+        seconds: (n) => {
+            return n * (1000);
+        },
+        /**
+         * @param d `Date` object
+         * @returns `number` milliseconds since epoch
+         */
+        date: (d) => {
+            return d.getTime();
+        }
+    },
+    to: {
+        hours: (n) => {
+            return n / (1000 * 60 * 60);
+        },
+        minutes: (n) => {
+            return n / (1000 * 60);
+        },
+        seconds: (n) => {
+            return n / (1000);
+        },
+        /**
+         * interprets `n` as milliseconds since epoch
+         * @param n `number` milliseconds
+         * @returns `Date` object
+         */
+        date: (n) => {
+            return new Date(n);
+        }
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "typeshi",
-    "version": "1.3.0",
+    "version": "1.5.0",
     "description": "TypeScript utility modules",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -23,25 +23,24 @@
     ],
     "author": "Andrew Garwood",
     "license": "MIT",
-    "devDependencies": {
-        "@types/jest": "^29.5.14",
-        "@types/node": "^22.15.15",
-        "addresser": "^1.1.20",
-        "axios": "^1.9.0",
-        "csv-parser": "^3.2.0",
-        "fastest-levenshtein": "^1.0.16",
-        "fs": "^0.0.1-security",
-        "jest": "^29.7.0",
-        "lodash": "^4.17.21",
-        "puppeteer-core": "^24.9.0",
+    "dependencies": {
         "rimraf": "^5.0.0",
         "ts-jest": "^29.3.4",
         "ts-node": "^10.9.2",
-        "tsconfig-paths": "^4.2.0",
         "tslog": "^4.9.3",
-        "typescript": "^5.0.0",
+        "lodash": "^4.17.21",
+        "addresser": "^1.1.20",
+        "csv-parser": "^3.2.0",
+        "fastest-levenshtein": "^1.0.16",
         "xlsx": "https://cdn.sheetjs.com/xlsx-latest/xlsx-latest.tgz"
     },
+    "devDependencies": {
+        "@types/jest": "^29.5.14",
+        "@types/node": "^22.15.15",
+        "jest": "^29.7.0",
+        "tsconfig-paths": "^4.2.0",
+        "typescript": "^5.0.0"
+    },
     "engines": {
         "node": ">=16.0.0"
     },