@nsnanocat/util 2.1.5 → 2.1.7

package/README.md

@@ -87,7 +87,7 @@ import {
 ### 仓库中存在但未从主入口导出
 - `lib/environment.mjs`
 - `lib/runScript.mjs`
-- `getStorage.mjs`（薯条项目自用，仅当你的存储结构与薯条项目一致时再使用）
+- `getStorage.mjs`（薯条项目自用，仅当你的存储结构与薯条项目一致时再使用；请通过子路径 `@nsnanocat/util/getStorage.mjs` 导入）
 
 ## 模块依赖关系
 
@@ -336,6 +336,24 @@ import getStorage from "@nsnanocat/util/getStorage.mjs";
 const store = getStorage("@my_box", ["YouTube", "Global"], database);
 ```
 
+#### 命名导出（辅助函数）
+
+`getStorage.mjs` 同时导出以下辅助函数：
+- `traverseObject(o, c)`：深度遍历对象并替换叶子值
+- `string2number(string)`：将纯数字字符串转换为数字
+- `value2array(value)`：字符串按逗号拆分；数字/布尔值会被包装为单元素数组
+
+示例：
+```js
+import getStorage, {
+  traverseObject,
+  string2number,
+  value2array,
+} from "@nsnanocat/util/getStorage.mjs";
+
+const store = getStorage("@my_box", ["YouTube", "Global"], database);
+```
+
 ### `polyfill/fetch.mjs`
 
 `fetch` 是仿照 Web API `Window.fetch` 设计的跨平台适配实现：
@@ -412,10 +430,12 @@ const store = getStorage("@my_box", ["YouTube", "Global"], database);
 #### `Storage.removeItem(keyName)`
 - Quantumult X：可用（`$prefs.removeValueForKey`）。
 - Surge：通过 `$persistentStore.write(null, keyName)` 删除。
-- Loon / Stash / Egern / Shadowrocket / Node.js：返回 `false`。
+- Node.js：可用（删除 `box.dat` 中对应 key 并落盘）。
+- Loon / Stash / Egern / Shadowrocket：返回 `false`。
 
 #### `Storage.clear()`
 - Quantumult X：可用（`$prefs.removeAllValues`）。
+- Node.js：可用（清空 `box.dat` 并落盘）。
 - 其他平台：返回 `false`。
 
 #### Node.js 特性
@@ -424,7 +444,7 @@ const store = getStorage("@my_box", ["YouTube", "Global"], database);
 
 与 Web Storage 的行为差异：
 - 支持 `@key.path` 深路径读写（Web Storage 原生不支持）。
-- `removeItem/clear` 仅部分平台可用（目前为 Quantumult X，以及 Surge 的 `removeItem`）。
+- `removeItem/clear` 仅部分平台可用（目前为 Quantumult X、Node.js，以及 Surge 的 `removeItem`）。
 - `getItem` 会尝试 `JSON.parse`，`setItem` 写入对象会 `JSON.stringify`。
 
 平台后端映射：
@@ -604,7 +624,7 @@ console.log(value); // 1
 | 通知 | `$notify` | `$notification.post` | `$notification.post` | `$notification.post` | `$notification.post` | `$notification.post` | 无 |
 | 持久化 | `$prefs` | `$persistentStore` | `$persistentStore` | `$persistentStore` | `$persistentStore` | `$persistentStore` | `box.dat` |
 | 结束脚本 | `$done` | `$done` | `$done` | `$done` | `$done` | `$done` | `process.exit(1)` |
-| `removeItem/clear` | 可用 | 不可用 | `removeItem` 可用 / `clear` 不可用 | 不可用 | 不可用 | 不可用 | 不可用 |
+| `removeItem/clear` | 可用 | 不可用 | `removeItem` 可用 / `clear` 不可用 | 不可用 | 不可用 | 不可用 | 可用 |
 | `policy` 注入（`fetch/done`） | `opts.policy` | `node` | `X-Surge-Policy`(done) | `X-Stash-Selected-Proxy` | 无专门映射 | `X-Surge-Proxy`(fetch) | 无 |
 
 ## 已知限制与注意事项

package/getStorage.mjs

@@ -106,12 +106,20 @@ export default function getStorage(key, names, database) {
 	/***************** traverseObject *****************/
 	traverseObject(Root.Settings, (key, value) => {
 		Console.debug("☑️ traverseObject", `${key}: ${typeof value}`, `${key}: ${JSON.stringify(value)}`);
-		if (value === "true" || value === "false")
-			value = JSON.parse(value); // 字符串转Boolean
-		else if (typeof value === "string") {
-			if (value.includes(","))
-				value = value.split(",").map(item => string2number(item)); // 字符串转数组转数字
-			else value = string2number(value); // 字符串转数字
+		switch (typeof value) {
+			case "string":
+				switch (value) {
+					case "true":
+					case "false":
+					case "[]":
+						value = JSON.parse(value); // 字符串转Boolean/空数组
+						break;
+					default:
+						if (value.includes(","))
+							value = value2array(value).map(item => string2number(item)); // 字符串转数组转数字
+						else value = string2number(value); // 字符串转数字
+				}
+				break;
 		}
 		return value;
 	});
@@ -128,7 +136,7 @@ export default function getStorage(key, names, database) {
  * @param {(key: string, value: any) => any} c 处理回调 / Transformer callback.
  * @returns {Record<string, any>}
  */
-function traverseObject(o, c) {
+export function traverseObject(o, c) {
 	for (const t in o) {
 		const n = o[t];
 		o[t] = "object" === typeof n && null !== n ? traverseObject(n, c) : c(t, n);
@@ -143,7 +151,26 @@ function traverseObject(o, c) {
  * @param {string} string 输入字符串 / Input string.
  * @returns {string|number}
  */
-function string2number(string) {
+export function string2number(string) {
 	if (/^\d+$/.test(string)) string = Number.parseInt(string, 10);
 	return string;
 }
+
+/**
+ * 将值包装为数组。
+ * Split value into array.
+ *
+ * @param {string|number|boolean|string[]|null|undefined} value 输入值 / Input value.
+ * @returns {(string|number|boolean)[]}
+ */
+export function value2array(value) {
+	switch (typeof value) {
+		case "string":
+			return value.split(",");
+		case "number":
+		case "boolean":
+			return [value];
+		default:
+			return value || [];
+	}
+}

package/package.json

@@ -41,5 +41,5 @@
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
-  "version": "2.1.5"
+  "version": "2.1.7"
 }

package/polyfill/Storage.mjs

@@ -208,7 +208,11 @@ export class Storage {
 						result = $prefs.removeValueForKey(keyName);
 						break;
 					case "Node.js":
-						result = false;
+						// result = false;
+						Storage.data = Storage.#loaddata(Storage.dataFile);
+						delete Storage.data[keyName];
+						Storage.#writedata(Storage.dataFile);
+						result = true;
 						break;
 					default:
 						result = false;
@@ -239,7 +243,11 @@ export class Storage {
 				result = $prefs.removeAllValues();
 				break;
 			case "Node.js":
-				result = false;
+				// result = false;
+				Storage.data = Storage.#loaddata(Storage.dataFile);
+				Storage.data = {};
+				Storage.#writedata(Storage.dataFile);
+				result = true;
 				break;
 			default:
 				result = false;

package/types/nsnanocat-util.d.ts

@@ -121,6 +121,15 @@ declare module "@nsnanocat/util/getStorage.mjs" {
 		Caches: Record<string, unknown>;
 	}
 
+	export function traverseObject(
+		o: Record<string, unknown>,
+		c: (key: string, value: unknown) => unknown,
+	): Record<string, unknown>;
+
+	export function string2number(string: string): string | number;
+
+	export function value2array(value: string | number | boolean | string[] | null | undefined): Array<string | number | boolean>;
+
 	export default function getStorage(
 		key: string,
 		names: string | string[] | Array<string | string[]>,