@jeniex/utils 1.1.2 → 1.1.4

package/browser/index.cjs

@@ -54,6 +54,11 @@ function asserted(object) {
     }
     return object;
 }
+function stringOrThrow(value) {
+    if (!isString(value)) {
+        throw new Error('Expected a string.');
+    }
+}
 function isTruthy(object) {
     return Boolean(object) === true;
 }
@@ -126,8 +131,6 @@ function capitalize(sentence) {
 }
 
 const scriptName = GM.info.script.name;
-/** The identifier of the script to be used in logging. */
-const logId = `[${scriptName}]:`;
 /** The initial tab URL on the script run. */
 const tabURL = window.location.href;
 
@@ -461,6 +464,7 @@ async function getOptions(flags) {
 
 function customizeConsole(debug = false) {
     const base = window.console;
+    const logId = `[${scriptName}]:`;
     return {
         log: base.log.bind(base, logId),
         warn: base.warn.bind(base, logId),
@@ -496,7 +500,6 @@ exports.isObject = isObject;
 exports.isString = isString;
 exports.isTruthy = isTruthy;
 exports.join = join;
-exports.logId = logId;
 exports.noop = noop;
 exports.padZeros = padZeros;
 exports.pageLoad = pageLoad;
@@ -507,5 +510,6 @@ exports.saveFile = saveFile;
 exports.scriptName = scriptName;
 exports.setSearchParam = setSearchParam;
 exports.sleep = sleep;
+exports.stringOrThrow = stringOrThrow;
 exports.tabURL = tabURL;
 exports.toString = toString;

package/browser/index.d.ts

@@ -17,6 +17,7 @@ declare function noop(): void;
 declare function toString(object: unknown): string;
 
 declare function asserted<T>(object: T | null | undefined): T;
+declare function stringOrThrow(value: unknown): asserts value is string;
 declare function isTruthy<T>(object: T): object is Exclude<T, '' | 0 | false | null | undefined>;
 declare function isFalsy(object: unknown): object is '' | 0 | false | null | undefined;
 declare function isNullish(object: unknown): object is null | undefined;
@@ -107,8 +108,6 @@ declare function setSearchParam(key: string, value: string, fullURL?: string): s
 declare function removeSearchParams(keys: string[], fullURL?: string): string;
 
 declare const scriptName: string;
-/** The identifier of the script to be used in logging. */
-declare const logId: string;
 /** The initial tab URL on the script run. */
 declare const tabURL: string;
 
@@ -169,4 +168,4 @@ interface CustomizedConsole {
 
 declare function customizeConsole(debug?: boolean): CustomizedConsole;
 
-export { $, $$, Flag, Fn, Nullable, Prettify, addStyle, alert, asserted, capitalize, checkVPN, checkVPNRandomly, confirm, customizeConsole, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, logId, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, saveFile, scriptName, setSearchParam, sleep, tabURL, toString };
+export { $, $$, Flag, Fn, Nullable, Prettify, addStyle, alert, asserted, capitalize, checkVPN, checkVPNRandomly, confirm, customizeConsole, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, saveFile, scriptName, setSearchParam, sleep, stringOrThrow, tabURL, toString };

package/browser/index.js

@@ -52,6 +52,11 @@ function asserted(object) {
     }
     return object;
 }
+function stringOrThrow(value) {
+    if (!isString(value)) {
+        throw new Error('Expected a string.');
+    }
+}
 function isTruthy(object) {
     return Boolean(object) === true;
 }
@@ -124,8 +129,6 @@ function capitalize(sentence) {
 }
 
 const scriptName = GM.info.script.name;
-/** The identifier of the script to be used in logging. */
-const logId = `[${scriptName}]:`;
 /** The initial tab URL on the script run. */
 const tabURL = window.location.href;
 
@@ -459,6 +462,7 @@ async function getOptions(flags) {
 
 function customizeConsole(debug = false) {
     const base = window.console;
+    const logId = `[${scriptName}]:`;
     return {
         log: base.log.bind(base, logId),
         warn: base.warn.bind(base, logId),
@@ -467,4 +471,4 @@ function customizeConsole(debug = false) {
     };
 }
 
-export { $, $$, addStyle, alert, asserted, capitalize, checkVPN, checkVPNRandomly, confirm, customizeConsole, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, logId, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, saveFile, scriptName, setSearchParam, sleep, tabURL, toString };
+export { $, $$, addStyle, alert, asserted, capitalize, checkVPN, checkVPNRandomly, confirm, customizeConsole, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, saveFile, scriptName, setSearchParam, sleep, stringOrThrow, tabURL, toString };

package/node/index.cjs

@@ -58,6 +58,11 @@ function asserted(object) {
     }
     return object;
 }
+function stringOrThrow(value) {
+    if (!isString(value)) {
+        throw new Error('Expected a string.');
+    }
+}
 function isTruthy(object) {
     return Boolean(object) === true;
 }
@@ -260,4 +265,5 @@ exports.readJSON = readJSON;
 exports.remove = remove;
 exports.removeFiles = removeFiles;
 exports.sleep = sleep;
+exports.stringOrThrow = stringOrThrow;
 exports.toString = toString;

package/node/index.d.ts

@@ -17,6 +17,7 @@ declare function noop(): void;
 declare function toString(object: unknown): string;
 
 declare function asserted<T>(object: T | null | undefined): T;
+declare function stringOrThrow(value: unknown): asserts value is string;
 declare function isTruthy<T>(object: T): object is Exclude<T, '' | 0 | false | null | undefined>;
 declare function isFalsy(object: unknown): object is '' | 0 | false | null | undefined;
 declare function isNullish(object: unknown): object is null | undefined;
@@ -109,4 +110,4 @@ declare function removeFiles({ folderPath, filter }: RemoveFilesOpt): Promise<vo
 
 declare function readJSON<T = object>(filePath: string, withComments?: boolean): Promise<T>;
 
-export { Fn, Nullable, Prettify, asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, sleep, toString };
+export { Fn, Nullable, Prettify, asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, sleep, stringOrThrow, toString };

package/node/index.js

@@ -56,6 +56,11 @@ function asserted(object) {
     }
     return object;
 }
+function stringOrThrow(value) {
+    if (!isString(value)) {
+        throw new Error('Expected a string.');
+    }
+}
 function isTruthy(object) {
     return Boolean(object) === true;
 }
@@ -237,4 +242,4 @@ async function readJSON(filePath, withComments = false) {
     return JSON.parse(stringJSON);
 }
 
-export { asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, sleep, toString };
+export { asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, sleep, stringOrThrow, toString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeniex/utils",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "author": "JenieX",
   "homepage": "https://github.com/JenieX/utils",
   "type": "module",