@ts-type/bluebird 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -3,6 +3,34 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.3](https://github.com/bluelovers/ws-ts-type/compare/@ts-type/bluebird@1.0.2...@ts-type/bluebird@1.0.3) (2026-03-07)
+
+**Note:** Version bump only for package @ts-type/bluebird
+
+
+
+
+
+## [1.0.2](https://github.com/bluelovers/ws-ts-type/compare/@ts-type/bluebird@1.0.1...@ts-type/bluebird@1.0.2) (2026-03-07)
+
+
+
+### 📚　Documentation
+
+* enhance documentation and JSDoc comments across multiple packages ([88ee99b](https://github.com/bluelovers/ws-ts-type/commit/88ee99b3a489645ca53093357cc3523dbe7996e0))
+
+
+### 🛠　Build System
+
+* 更新多個套件的 test 指令為 jest ([61ea53b](https://github.com/bluelovers/ws-ts-type/commit/61ea53bf15fc3ed0e216793200604ae5a52079c9))
+
+
+### ♻️　Chores
+
+* migrate from yarn to pnpm and enhance test infrastructure ([8a5daa2](https://github.com/bluelovers/ws-ts-type/commit/8a5daa2f2022eaf025c3349d4fe5dc8971f8c077))
+
+
+
 ## 1.0.1 (2022-10-10)
 
 

package/README.md

@@ -1,8 +1,21 @@
-# README.md
+# @ts-type/bluebird
 
-    
+Bluebird Promise 類型的增強類型定義
 
-## install
+Enhanced type definitions for Bluebird Promise
+
+## 功能特點 / Features
+
+- Bluebird Promise 類型別名
+- Bluebird Promise type aliases
+- 函式包裝為 Bluebird Promise
+- Wrap functions to return Bluebird Promise
+- 支援 promisifyAll 類型
+- Support promisifyAll types
+- 元組轉換為 Inspection 類型
+- Tuple to Inspection type conversion
+
+## 安裝 / Install
 
 ```bash
 yarn add @ts-type/bluebird
@@ -10,3 +23,20 @@ yarn-tool add @ts-type/bluebird
 yt add @ts-type/bluebird
 ```
 
+## 使用範例 / Usage Example
+
+```typescript
+import type { IBluebird, ITSBluebirdPromisifyAll, ITSResultArrayToBluebirdInspection } from '@ts-type/bluebird';
+import Bluebird from 'bluebird';
+
+// 使用 Bluebird 類型別名
+type MyPromise = IBluebird<string>;
+
+// 將物件方法轉換為 Bluebird Promise
+interface IOriginal {
+    fetchData(): Promise<string>;
+}
+
+type IPromisified = ITSBluebirdPromisifyAll<IOriginal>;
+```
+

package/index.d.ts

@@ -2,17 +2,62 @@ import Bluebird from 'bluebird';
 import { ITSKeyOfRecordExtractToKey } from 'ts-type/lib/helper/record/pick-type';
 import { ITSAnyFunction } from 'ts-type/lib/type/base';
 import { ITSAwaitedReturnType } from 'ts-type/lib/helper/promise';
+/**
+ * Bluebird Promise 類型的別名
+ * Bluebird Promise type alias
+ *
+ * @typeParam T - Promise 解決值的類型 / Type of the resolved value
+ */
 export type IBluebird<T> = Bluebird<T>;
+/**
+ * Bluebird Promise 類型的別名（較短名稱）
+ * Bluebird Promise type alias (shorter name)
+ *
+ * @typeParam T - Promise 解決值的類型 / Type of the resolved value
+ */
 export type ITSBluebird<T> = Bluebird<T>;
+/**
+ * 將函式包裝為回傳 Bluebird Promise 的函式
+ * Wrap a function to return Bluebird Promise
+ *
+ * @typeParam T - 原函式類型 / Original function type
+ * @example
+ * function add(a: number, b: number): number { return a + b; }
+ * const bluebirdAdd = wrapFunctionBluebird(add);
+ * // bluebirdAdd(1, 2) returns Bluebird<number>
+ */
 export type ITSWrapFunctionBluebird<T extends (...args: any[]) => any> = (...args: Parameters<T>) => IBluebird<ITSAwaitedReturnType<T>>;
+/**
+ * 將物件的所有函式屬性轉換為 Bluebird Promise 版本
+ * Convert all function properties of an object to Bluebird Promise version
+ *
+ * @typeParam T - 目標物件類型 / Target object type
+ * @typeParam K - 提取的函式鍵名 / Extracted function keys
+ */
 export type ITSBluebirdPromisifyAll<T extends {
     [p: string | symbol]: ITSAnyFunction;
 }, K extends ITSKeyOfRecordExtractToKey<T, Function> = ITSKeyOfRecordExtractToKey<T, Function>> = Omit<T, K> & {
     [P in K]: (...argv: Parameters<T[P]>) => IBluebird<ITSAwaitedReturnType<T[P]>>;
 };
+/**
+ * 將物件的所有函式屬性轉換為標準 Promise 版本（非 Bluebird）
+ * Convert all function properties of an object to standard Promise version (non-Bluebird)
+ *
+ * @typeParam T - 目標物件類型 / Target object type
+ * @typeParam K - 提取的函式鍵名 / Extracted function keys
+ */
 export type ITSPromisifyAll<T extends {
     [p: string | symbol]: ITSAnyFunction;
 }, K extends ITSKeyOfRecordExtractToKey<T, Function> = ITSKeyOfRecordExtractToKey<T, Function>> = Omit<T, K> & {
     [P in K]: (...argv: Parameters<T[P]>) => Promise<ITSAwaitedReturnType<T[P]>>;
 };
+/**
+ * 將元組類型轉換為 Bluebird Inspection 類型的元組
+ * Convert tuple type to tuple of Bluebird Inspection types
+ *
+ * 用於處理 Promise.allSettled 的結果類型
+ * Used for handling Promise.allSettled result types
+ *
+ * @typeParam T - 輸入的元組類型 / Input tuple type
+ */
 export type ITSResultArrayToBluebirdInspection<T> = T extends [infer T1, infer T2, infer T3, infer T4, infer T5] ? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>, Bluebird.Inspection<T3>, Bluebird.Inspection<T4>, Bluebird.Inspection<T5>] : T extends [infer T1, infer T2, infer T3, infer T4] ? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>, Bluebird.Inspection<T3>, Bluebird.Inspection<T4>] : T extends [infer T1, infer T2, infer T3] ? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>, Bluebird.Inspection<T3>] : T extends [infer T1, infer T2] ? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>] : T extends [infer T1] ? [Bluebird.Inspection<T1>] : T extends (infer R)[] ? Bluebird.Inspection<R>[] : never;

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"","sourcesContent":["import Bluebird from 'bluebird';\n\nimport { ITSKeyOfRecordExtractToKey } from 'ts-type/lib/helper/record/pick-type';\nimport { ITSAnyFunction } from 'ts-type/lib/type/base';\nimport { ITSAwaitedReturnType } from 'ts-type/lib/helper/promise';\n\nexport type IBluebird<T> = Bluebird<T>;\nexport type ITSBluebird<T> = Bluebird<T>;\n\nexport type ITSWrapFunctionBluebird<T extends (...args: any[]) => any> =\n\t(...args: Parameters<T>) => IBluebird<ITSAwaitedReturnType<T>>;\n\nexport type ITSBluebirdPromisifyAll<T extends {\n\t[p: string | symbol]: ITSAnyFunction\n}, K extends ITSKeyOfRecordExtractToKey<T, Function> = ITSKeyOfRecordExtractToKey<T, Function>> = Omit<T, K> & {\n\t[P in K]: (...argv: Parameters<T[P]>) => IBluebird<ITSAwaitedReturnType<T[P]>>\n}\n\nexport type ITSPromisifyAll<T extends {\n\t[p: string | symbol]: ITSAnyFunction\n}, K extends ITSKeyOfRecordExtractToKey<T, Function> = ITSKeyOfRecordExtractToKey<T, Function>> = Omit<T, K> & {\n\t[P in K]: (...argv: Parameters<T[P]>) => Promise<ITSAwaitedReturnType<T[P]>>\n}\n\nexport type ITSResultArrayToBluebirdInspection<T> = T extends [infer T1, infer T2, infer T3, infer T4, infer T5]\n\t? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>, Bluebird.Inspection<T3>, Bluebird.Inspection<T4>, Bluebird.Inspection<T5>]\n\t: T extends [infer T1, infer T2, infer T3, infer T4]\n\t\t? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>, Bluebird.Inspection<T3>, Bluebird.Inspection<T4>]\n\t\t: T extends [infer T1, infer T2, infer T3]\n\t\t\t? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>, Bluebird.Inspection<T3>]\n\t\t\t: T extends [infer T1, infer T2] ? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>] : T extends [infer T1]\n\t\t\t\t? [Bluebird.Inspection<T1>]\n\t\t\t\t: T extends (infer R)[] ? Bluebird.Inspection<R>[] : never;\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"","sourcesContent":["import Bluebird from 'bluebird';\n\nimport { ITSKeyOfRecordExtractToKey } from 'ts-type/lib/helper/record/pick-type';\nimport { ITSAnyFunction } from 'ts-type/lib/type/base';\nimport { ITSAwaitedReturnType } from 'ts-type/lib/helper/promise';\n\n/**\n * Bluebird Promise 類型的別名\n * Bluebird Promise type alias\n *\n * @typeParam T - Promise 解決值的類型 / Type of the resolved value\n */\nexport type IBluebird<T> = Bluebird<T>;\n\n/**\n * Bluebird Promise 類型的別名（較短名稱）\n * Bluebird Promise type alias (shorter name)\n *\n * @typeParam T - Promise 解決值的類型 / Type of the resolved value\n */\nexport type ITSBluebird<T> = Bluebird<T>;\n\n/**\n * 將函式包裝為回傳 Bluebird Promise 的函式\n * Wrap a function to return Bluebird Promise\n *\n * @typeParam T - 原函式類型 / Original function type\n * @example\n * function add(a: number, b: number): number { return a + b; }\n * const bluebirdAdd = wrapFunctionBluebird(add);\n * // bluebirdAdd(1, 2) returns Bluebird<number>\n */\nexport type ITSWrapFunctionBluebird<T extends (...args: any[]) => any> =\n\t(...args: Parameters<T>) => IBluebird<ITSAwaitedReturnType<T>>;\n\n/**\n * 將物件的所有函式屬性轉換為 Bluebird Promise 版本\n * Convert all function properties of an object to Bluebird Promise version\n *\n * @typeParam T - 目標物件類型 / Target object type\n * @typeParam K - 提取的函式鍵名 / Extracted function keys\n */\nexport type ITSBluebirdPromisifyAll<T extends {\n\t[p: string | symbol]: ITSAnyFunction\n}, K extends ITSKeyOfRecordExtractToKey<T, Function> = ITSKeyOfRecordExtractToKey<T, Function>> = Omit<T, K> & {\n\t[P in K]: (...argv: Parameters<T[P]>) => IBluebird<ITSAwaitedReturnType<T[P]>>\n}\n\n/**\n * 將物件的所有函式屬性轉換為標準 Promise 版本（非 Bluebird）\n * Convert all function properties of an object to standard Promise version (non-Bluebird)\n *\n * @typeParam T - 目標物件類型 / Target object type\n * @typeParam K - 提取的函式鍵名 / Extracted function keys\n */\nexport type ITSPromisifyAll<T extends {\n\t[p: string | symbol]: ITSAnyFunction\n}, K extends ITSKeyOfRecordExtractToKey<T, Function> = ITSKeyOfRecordExtractToKey<T, Function>> = Omit<T, K> & {\n\t[P in K]: (...argv: Parameters<T[P]>) => Promise<ITSAwaitedReturnType<T[P]>>\n}\n\n/**\n * 將元組類型轉換為 Bluebird Inspection 類型的元組\n * Convert tuple type to tuple of Bluebird Inspection types\n *\n * 用於處理 Promise.allSettled 的結果類型\n * Used for handling Promise.allSettled result types\n *\n * @typeParam T - 輸入的元組類型 / Input tuple type\n */\nexport type ITSResultArrayToBluebirdInspection<T> = T extends [infer T1, infer T2, infer T3, infer T4, infer T5]\n\t? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>, Bluebird.Inspection<T3>, Bluebird.Inspection<T4>, Bluebird.Inspection<T5>]\n\t: T extends [infer T1, infer T2, infer T3, infer T4]\n\t\t? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>, Bluebird.Inspection<T3>, Bluebird.Inspection<T4>]\n\t\t: T extends [infer T1, infer T2, infer T3]\n\t\t\t? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>, Bluebird.Inspection<T3>]\n\t\t\t: T extends [infer T1, infer T2] ? [Bluebird.Inspection<T1>, Bluebird.Inspection<T2>] : T extends [infer T1]\n\t\t\t\t? [Bluebird.Inspection<T1>]\n\t\t\t\t: T extends (infer R)[] ? Bluebird.Inspection<R>[] : never;\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ts-type/bluebird",
-  "version": "1.0.1",
-  "description": "",
+  "version": "1.0.3",
+  "description": "Bluebird Promise 類型的增強類型定義 | Enhanced type definitions for Bluebird Promise",
   "keywords": [
     ".d.ts",
     "@types",
@@ -49,19 +49,20 @@
     "lint": "yarn run lint:eslint",
     "lint:eslint": "ynpx eslint --ext .ts,.tsx,.mts,.cts ./",
     "pretest": "echo pretest",
-    "test": "echo \"Error: no test specified\"",
+    "test": "jest --passWithNoTests",
     "test:jest": "jest --passWithNoTests",
+    "test:jest:coverage": "node --run test:jest -- --coverage",
     "test:jest:snapshot": "yarn run test:jest -- -u",
     "test:mocha": "ynpx --quiet -p ts-node -p mocha mocha -- --require ts-node/register \"!(node_modules)/**/*.{test,spec}.{ts,tsx}\"",
     "test:snapshot": "yarn run test -- -u",
     "test:tsd": "ynpx tsd",
-    "test:tsdx": "ynpx @bluelovers/tsdx test --passWithNoTests",
+    "test:tsdx": "tsdx test --passWithNoTests",
     "build:dts:bundle": "ynpx dts-bundle-generator -o ./dist/index.d.ts ./src/index.ts --no-banner --inline-declare-global & echo build:dts:bundle",
     "build:dts:copy": "copy .\\src\\index.d.ts .\\dist\\index.d.ts & echo build:dts",
     "build:dts:tsc": "yarn run build:dts:tsc:emit && yarn run build:dts:copy",
     "build:dts:tsc:emit": "tsc --emitDeclarationOnly --declaration --noEmit false",
     "build:microbundle": "ynpx microbundle --target node",
-    "build:tsdx": "ynpx @bluelovers/tsdx build --target node --name index",
+    "build:tsdx": "tsdx build --target node --name index",
     "ci:install": "echo ci:install",
     "ci:build": "echo ci:build",
     "preversion": "echo preversion && yarn run test",
@@ -83,11 +84,10 @@
   },
   "dependencies": {
     "@types/bluebird": "*",
-    "ts-type": "^3.0.1"
+    "ts-type": "^3.0.3"
   },
-  "packageManager": "yarn@1.22.19",
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fa34eea119b9bcbb363061ddffcfe9d78c2d0ddd"
+  "gitHead": "4ef633a04245358fed59633c9d9ceff0607d30d3"
 }