typed-http-headers 1.0.7 → 1.0.9

package/CHANGELOG.md

@@ -3,6 +3,47 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.9](https://github.com/bluelovers/ws-ts-type/compare/typed-http-headers@1.0.8...typed-http-headers@1.0.9) (2026-03-07)
+
+
+
+### 📚　Documentation
+
+* enhance documentation and JSDoc comments across multiple packages ([88ee99b](https://github.com/bluelovers/ws-ts-type/commit/88ee99b3a489645ca53093357cc3523dbe7996e0))
+* **ts-type:** add bilingual JSDoc comments to helper types and test files ([5893036](https://github.com/bluelovers/ws-ts-type/commit/58930369f50f454595241e5573bdcc03dea4654b))
+
+
+### 🛠　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.8](https://github.com/bluelovers/ws-ts-type/compare/typed-http-headers@1.0.7...typed-http-headers@1.0.8) (2022-10-10)
+
+
+
+### 🛠　Build System
+
+* update typescript ([eb59d89](https://github.com/bluelovers/ws-ts-type/commit/eb59d897c2888c7a45406ffcad4b9033608b0b66))
+
+
+### 📌　Dependencies
+
+* update deps ([ab5f3e4](https://github.com/bluelovers/ws-ts-type/commit/ab5f3e48da1f10ddd4445ba6dda9a0a68c5f656f))
+
+
+### 🔖　Miscellaneous
+
+* . ([9219017](https://github.com/bluelovers/ws-ts-type/commit/92190178fcf30f881c1d0d36fb141a3394ab3b38))
+
+
+
 ## [1.0.7](https://github.com/bluelovers/ws-ts-type/compare/typed-http-headers@1.0.6...typed-http-headers@1.0.7) (2020-06-01)
 
 **Note:** Version bump only for package typed-http-headers

package/README.md

@@ -1,7 +1,49 @@
-# README
+# ts-http-header
 
-    typed http headers
+標準 HTTP 請求與回應標頭的 TypeScript 類型定義
 
+TypeScript type definitions for standard HTTP request and response headers
+
+## 功能特點 / Features
+
+- 完整的 HTTP 請求標頭類型定義
+- Complete HTTP request header type definitions
+- 完整的 HTTP 回應標頭類型定義
+- Complete HTTP response header type definitions
+- 參考 RFC 7231 標準
+- Reference RFC 7231 standard
+- 支援標準與非標準標頭
+- Support standard and non-standard headers
+
+## 安裝 / Install
+
+```bash
+yarn add ts-http-header
+yarn-tool add ts-http-header
+yt add ts-http-header
 ```
-yarn add typed-http-headers
+
+## 使用範例 / Usage Example
+
+```typescript
+import { IRequestHeaders, IResponseHeaders, IHeaders } from 'ts-http-header';
+
+// 使用請求標頭類型
+const requestHeaders: IRequestHeaders = {
+    'Content-Type': 'application/json',
+    'Authorization': 'Bearer token123',
+};
+
+// 使用回應標頭類型
+const responseHeaders: IResponseHeaders = {
+    'Content-Type': 'application/json',
+    'Content-Length': '1024',
+    'Cache-Control': 'max-age=3600',
+};
+
+// 合併標頭類型
+const allHeaders: IHeaders = {
+    ...requestHeaders,
+    ...responseHeaders,
+};
 ```

package/index.d.ts

@@ -1,12 +1,40 @@
 /**
- * Created by user on 2019/6/9.
+ * HTTP 請求與回應標頭類型定義
+ * HTTP Request and Response Header type definitions
+ *
+ * 包含標準 HTTP 請求和回應標頭的類型定義
+ * Contains type definitions for standard HTTP request and response headers
+ *
+ * @package
  */
 import IRequestHeaders from './lib/request';
 import IResponseHeaders from './lib/response';
 import { ITSPartialRecord } from 'ts-type';
+/**
+ * 請求標頭介面
+ * Request headers interface
+ */
 export { IRequestHeaders, IResponseHeaders };
-export declare type IHttpHeaderValues = string | number | boolean | string[];
+/**
+ * HTTP 標頭值類型
+ * HTTP header value types
+ *
+ * 支援字串、數字、布林值或字串陣列
+ * Supports string, number, boolean, or string array
+ */
+export type IHttpHeaderValues = string | number | boolean | string[];
+/**
+ * 合併請求與回應標頭的完整標頭介面
+ * Combined request and response headers interface
+ */
 export interface IHeaders extends IRequestHeaders, IResponseHeaders {
 }
-export declare type ILazyHeaders<T extends string = string, V = IHttpHeaderValues> = ITSPartialRecord<T, V>;
+/**
+ * 載入的標頭類型（可選鍵值）
+ * Loaded headers type (optional key-value)
+ *
+ * @typeParam T - 標頭鍵名類型 / Header key type
+ * @typeParam V - 標頭值類型 / Header value type
+ */
+export type ILazyHeaders<T extends string = string, V = IHttpHeaderValues> = ITSPartialRecord<T, V>;
 export default IHeaders;

package/index.js

@@ -1,6 +1,12 @@
 "use strict";
 /**
- * Created by user on 2019/6/9.
+ * HTTP 請求與回應標頭類型定義
+ * HTTP Request and Response Header type definitions
+ *
+ * 包含標準 HTTP 請求和回應標頭的類型定義
+ * Contains type definitions for standard HTTP request and response headers
+ *
+ * @package
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;GAEG","sourcesContent":["/**\n * Created by user on 2019/6/9.\n */\n\nimport IRequestHeaders from './lib/request';\nimport IResponseHeaders from './lib/response';\nimport { ITSPartialRecord } from 'ts-type';\n\nexport { IRequestHeaders, IResponseHeaders };\n\nexport type IHttpHeaderValues = string | number | boolean | string[];\n\nexport interface IHeaders extends IRequestHeaders, IResponseHeaders\n{\n\n}\n\nexport type ILazyHeaders<T extends string = string, V = IHttpHeaderValues> = ITSPartialRecord<T, V>;\n\nexport default IHeaders;\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * HTTP 請求與回應標頭類型定義\n * HTTP Request and Response Header type definitions\n *\n * 包含標準 HTTP 請求和回應標頭的類型定義\n * Contains type definitions for standard HTTP request and response headers\n *\n * @package\n */\n\nimport IRequestHeaders from './lib/request';\nimport IResponseHeaders from './lib/response';\nimport { ITSPartialRecord } from 'ts-type';\n\n/**\n * 請求標頭介面\n * Request headers interface\n */\nexport { IRequestHeaders, IResponseHeaders };\n\n/**\n * HTTP 標頭值類型\n * HTTP header value types\n *\n * 支援字串、數字、布林值或字串陣列\n * Supports string, number, boolean, or string array\n */\nexport type IHttpHeaderValues = string | number | boolean | string[];\n\n/**\n * 合併請求與回應標頭的完整標頭介面\n * Combined request and response headers interface\n */\nexport interface IHeaders extends IRequestHeaders, IResponseHeaders\n{\n\n}\n\n/**\n * 載入的標頭類型（可選鍵值）\n * Loaded headers type (optional key-value)\n *\n * @typeParam T - 標頭鍵名類型 / Header key type\n * @typeParam V - 標頭值類型 / Header value type\n */\nexport type ILazyHeaders<T extends string = string, V = IHttpHeaderValues> = ITSPartialRecord<T, V>;\n\nexport default IHeaders;\n"]}

package/lib/request/standard.d.ts

@@ -1,3 +1,12 @@
+/**
+ * 標準 HTTP 請求標頭欄位定義
+ * Standard HTTP Request Header Fields Definition
+ *
+ * 參考 RFC 7231 定義的 HTTP 請求標頭
+ * Reference RFC 7231 for HTTP request header definitions
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
+ */
 export interface IStandardRequestFields {
     'A-IM'?: string;
     'Accept'?: string;

package/lib/request/standard.js

@@ -1,3 +1,12 @@
 "use strict";
+/**
+ * 標準 HTTP 請求標頭欄位定義
+ * Standard HTTP Request Header Fields Definition
+ *
+ * 參考 RFC 7231 定義的 HTTP 請求標頭
+ * Reference RFC 7231 for HTTP request header definitions
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=standard.js.map

package/lib/request/standard.js.map

@@ -1 +1 @@
-{"version":3,"file":"standard.js","sourceRoot":"","sources":["standard.ts"],"names":[],"mappings":"","sourcesContent":["\n\nexport interface IStandardRequestFields\n{\n\t'A-IM'?: string,\n\t'Accept'?: string,\n\t'Accept-Charset'?: string,\n\t'Accept-Encoding'?: string,\n\t'Accept-Language'?: string,\n\t'Accept-Datetime'?: string,\n\t'Access-Control-Request-Method'?: string,\n\t'Access-Control-Request-Headers'?: string,\n\t'Authorization'?: string,\n\t'Cache-Control'?: string,\n\t'Connection'?: string,\n\t'Content-Length'?: string,\n\t'Content-MD5'?: string,\n\t'Content-Type'?: string,\n\t'Cookie'?: string,\n\t'Date'?: string,\n\t'Expect'?: string,\n\t'Forwarded'?: string,\n\t'From'?: string,\n\t'Host'?: string,\n\t'HTTP2-Settings'?: string,\n\t'If-Match'?: string,\n\t'If-Modified-Since'?: string,\n\t'If-None-Match'?: string,\n\t'If-Range'?: string,\n\t'If-Unmodified-Since'?: string,\n\t'Max-Forwards'?: string,\n\t'Origin'?: string,\n\t'Pragma'?: string,\n\t'Proxy-Authorization'?: string,\n\t'Range'?: string,\n\t'Referer'?: string,\n\t'TE'?: string,\n\t'User-Agent'?: string,\n\t'Upgrade'?: string,\n\t'Via'?: string,\n\t'Warning'?: string,\n}\n\nexport default IStandardRequestFields;\n"]}
+{"version":3,"file":"standard.js","sourceRoot":"","sources":["standard.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * 標準 HTTP 請求標頭欄位定義\n * Standard HTTP Request Header Fields Definition\n *\n * 參考 RFC 7231 定義的 HTTP 請求標頭\n * Reference RFC 7231 for HTTP request header definitions\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers\n */\n\nexport interface IStandardRequestFields\n{\n\t'A-IM'?: string,\n\t'Accept'?: string,\n\t'Accept-Charset'?: string,\n\t'Accept-Encoding'?: string,\n\t'Accept-Language'?: string,\n\t'Accept-Datetime'?: string,\n\t'Access-Control-Request-Method'?: string,\n\t'Access-Control-Request-Headers'?: string,\n\t'Authorization'?: string,\n\t'Cache-Control'?: string,\n\t'Connection'?: string,\n\t'Content-Length'?: string,\n\t'Content-MD5'?: string,\n\t'Content-Type'?: string,\n\t'Cookie'?: string,\n\t'Date'?: string,\n\t'Expect'?: string,\n\t'Forwarded'?: string,\n\t'From'?: string,\n\t'Host'?: string,\n\t'HTTP2-Settings'?: string,\n\t'If-Match'?: string,\n\t'If-Modified-Since'?: string,\n\t'If-None-Match'?: string,\n\t'If-Range'?: string,\n\t'If-Unmodified-Since'?: string,\n\t'Max-Forwards'?: string,\n\t'Origin'?: string,\n\t'Pragma'?: string,\n\t'Proxy-Authorization'?: string,\n\t'Range'?: string,\n\t'Referer'?: string,\n\t'TE'?: string,\n\t'User-Agent'?: string,\n\t'Upgrade'?: string,\n\t'Via'?: string,\n\t'Warning'?: string,\n}\n\nexport default IStandardRequestFields;\n"]}

package/lib/response/standard.d.ts

@@ -1,5 +1,11 @@
 /**
- * Created by user on 2019/6/9.
+ * 標準 HTTP 回應標頭欄位定義
+ * Standard HTTP Response Header Fields Definition
+ *
+ * 參考 RFC 7231 定義的 HTTP 回應標頭
+ * Reference RFC 7231 for HTTP response header definitions
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
  */
 export interface IStandardResponseFields {
     'Access-Control-Allow-Origin'?: string;

package/lib/response/standard.js

@@ -1,6 +1,12 @@
 "use strict";
 /**
- * Created by user on 2019/6/9.
+ * 標準 HTTP 回應標頭欄位定義
+ * Standard HTTP Response Header Fields Definition
+ *
+ * 參考 RFC 7231 定義的 HTTP 回應標頭
+ * Reference RFC 7231 for HTTP response header definitions
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=standard.js.map

package/lib/response/standard.js.map

@@ -1 +1 @@
-{"version":3,"file":"standard.js","sourceRoot":"","sources":["standard.ts"],"names":[],"mappings":";AAAA;;GAEG","sourcesContent":["/**\n * Created by user on 2019/6/9.\n */\n\nexport interface IStandardResponseFields\n{\n\t'Access-Control-Allow-Origin'?: string,\n\t'Access-Control-Allow-Credentials'?: string,\n\t'Access-Control-Expose-Headers'?: string,\n\t'Access-Control-Max-Age'?: string,\n\t'Access-Control-Allow-Methods'?: string,\n\t'Access-Control-Allow-Headers'?: string,\n\t'Accept-Patch'?: string,\n\t'Accept-Ranges'?: string,\n\t'Age'?: string,\n\t'Allow'?: string,\n\t'Alt-Svc'?: string,\n\t'Cache-Control'?: string,\n\t'Connection'?: string,\n\t'Content-Disposition'?: string,\n\t'Content-Encoding'?: string,\n\t'Content-Language'?: string,\n\t'Content-Length'?: string,\n\t'Content-Location'?: string,\n\t'Content-MD5'?: string,\n\t'Content-Range'?: string,\n\t'Content-Type'?: string,\n\t'Date'?: string,\n\t'Delta-Base'?: string,\n\t'ETag'?: string,\n\t'Expires'?: string,\n\t'IM'?: string,\n\t'Last-Modified'?: string,\n\t'Link'?: string,\n\t'Location'?: string,\n\t'P3P'?: string,\n\t'Pragma'?: string,\n\t'Proxy-Authenticate'?: string,\n\t'Public-Key-Pins'?: string,\n\t'Retry-After'?: string,\n\t'Server'?: string,\n\t'Set-Cookie'?: string,\n\t'Strict-Transport-Security'?: string,\n\t'Trailer'?: string,\n\t'Transfer-Encoding'?: string,\n\t'Tk'?: string,\n\t'Upgrade'?: string,\n\t'Vary'?: string,\n\t'Via'?: string,\n\t'Warning'?: string,\n\t'WWW-Authenticate'?: string,\n\t'X-Frame-Options'?: string,\n}\n\nexport default IStandardResponseFields;\n"]}
+{"version":3,"file":"standard.js","sourceRoot":"","sources":["standard.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * 標準 HTTP 回應標頭欄位定義\n * Standard HTTP Response Header Fields Definition\n *\n * 參考 RFC 7231 定義的 HTTP 回應標頭\n * Reference RFC 7231 for HTTP response header definitions\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers\n */\n\nexport interface IStandardResponseFields\n{\n\t'Access-Control-Allow-Origin'?: string,\n\t'Access-Control-Allow-Credentials'?: string,\n\t'Access-Control-Expose-Headers'?: string,\n\t'Access-Control-Max-Age'?: string,\n\t'Access-Control-Allow-Methods'?: string,\n\t'Access-Control-Allow-Headers'?: string,\n\t'Accept-Patch'?: string,\n\t'Accept-Ranges'?: string,\n\t'Age'?: string,\n\t'Allow'?: string,\n\t'Alt-Svc'?: string,\n\t'Cache-Control'?: string,\n\t'Connection'?: string,\n\t'Content-Disposition'?: string,\n\t'Content-Encoding'?: string,\n\t'Content-Language'?: string,\n\t'Content-Length'?: string,\n\t'Content-Location'?: string,\n\t'Content-MD5'?: string,\n\t'Content-Range'?: string,\n\t'Content-Type'?: string,\n\t'Date'?: string,\n\t'Delta-Base'?: string,\n\t'ETag'?: string,\n\t'Expires'?: string,\n\t'IM'?: string,\n\t'Last-Modified'?: string,\n\t'Link'?: string,\n\t'Location'?: string,\n\t'P3P'?: string,\n\t'Pragma'?: string,\n\t'Proxy-Authenticate'?: string,\n\t'Public-Key-Pins'?: string,\n\t'Retry-After'?: string,\n\t'Server'?: string,\n\t'Set-Cookie'?: string,\n\t'Strict-Transport-Security'?: string,\n\t'Trailer'?: string,\n\t'Transfer-Encoding'?: string,\n\t'Tk'?: string,\n\t'Upgrade'?: string,\n\t'Vary'?: string,\n\t'Via'?: string,\n\t'Warning'?: string,\n\t'WWW-Authenticate'?: string,\n\t'X-Frame-Options'?: string,\n}\n\nexport default IStandardResponseFields;\n"]}

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "typed-http-headers",
-  "version": "1.0.7",
-  "description": "typed http headers",
-  "homepage": "https://github.com/bluelovers/ws-ts-type#readme",
+  "version": "1.0.9",
+  "description": "標準 HTTP 請求與回應標頭的 TypeScript 類型定義 | TypeScript type definitions for standard HTTP request and response headers",
+  "homepage": "https://github.com/bluelovers/ws-ts-type/tree/master/packages/ts-http-header#readme",
   "bugs": {
     "url": "https://github.com/bluelovers/ws-ts-type/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bluelovers/ws-ts-type.git"
+    "url": "git+https://github.com/bluelovers/ws-ts-type.git",
+    "directory": "packages/ts-http-header"
   },
   "license": "ISC",
   "author": "",
@@ -16,11 +17,21 @@
   "scripts": {
     "coverage": "npx nyc npm run test",
     "lint": "npx eslint **/*.ts",
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest --passWithNoTests",
+    "test:jest": "jest --passWithNoTests",
+    "test:jest:coverage": "node --run test:jest -- --coverage",
+    "test:jest:snapshot": "yarn run test:jest -- -u",
+    "test:snapshot": "yarn run test -- -u",
+    "test:tsd": "ynpx tsd",
+    "preversion": "yarn run test",
     "prepublishOnly": "npm run ncu && npm run sort-package-json",
     "postpublish_": "git commit -m \"publish new version\" .",
     "ncu": "npx yarn-tool ncu -u",
-    "sort-package-json": "npx yarn-tool sort"
+    "sort-package-json": "npx yarn-tool sort",
+    "tsc:showConfig": "ynpx get-current-tsconfig -p"
   },
-  "gitHead": "2b483bcc6bab2a5fbe0b0cfe2a27f736bf5db793"
+  "dependencies": {
+    "ts-type": "^3.0.2"
+  },
+  "gitHead": "57f82cba146cfef0d0f3f138e5ec736cd17f040d"
 }