@d-matrix/utils 1.3.0 → 1.5.0

package/dist/file.d.ts

@@ -20,4 +20,20 @@ export declare const validateImageSize: (file: BlobPart | FileURL, limitSize: {
     width: number;
     height: number;
 }, options?: BlobPropertyBag | undefined) => Promise<ImageSizeValidationResult>;
+/**
+ * 检测图片地址是否可用
+ * @param src 图片地址
+ * @param img HTMLImageElement
+ * @returns Promise<boolean>
+ */
+export declare function isImageExists(src: string, img?: HTMLImageElement): Promise<boolean>;
+/**
+ * 从Content-Disposition中获取文件名
+ * @param header 包含Content-Disposition, 值为'attachment;filename=%E5%A4%A7%E8%A1%8C%E6%8C%87%E5%AF%BC2024-06-27-2024-06-28.xlsx'
+ * @returns string
+ *
+ */
+export declare function getFilenameFromContentDispositionHeader(header: {
+    ['content-disposition']: string;
+}): string;
 export {};

package/dist/file.js

@@ -36,7 +36,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateImageSize = exports.toImage = void 0;
+exports.getFilenameFromContentDispositionHeader = exports.isImageExists = exports.validateImageSize = exports.toImage = void 0;
 /**
  * 转换BlobPart或者文件地址为图片对象
  * @param file 传入文件 或者 url
@@ -87,3 +87,38 @@ var validateImageSize = function (file, limitSize, options) { return __awaiter(v
     });
 }); };
 exports.validateImageSize = validateImageSize;
+/**
+ * 检测图片地址是否可用
+ * @param src 图片地址
+ * @param img HTMLImageElement
+ * @returns Promise<boolean>
+ */
+function isImageExists(src, img) {
+    if (img === void 0) { img = new Image(); }
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (!src)
+                return [2 /*return*/, false];
+            return [2 /*return*/, new Promise(function (resolve) {
+                    img.src = src;
+                    img.onload = function () { return resolve(true); };
+                    img.onerror = function () { return resolve(false); };
+                })];
+        });
+    });
+}
+exports.isImageExists = isImageExists;
+/**
+ * 从Content-Disposition中获取文件名
+ * @param header 包含Content-Disposition, 值为'attachment;filename=%E5%A4%A7%E8%A1%8C%E6%8C%87%E5%AF%BC2024-06-27-2024-06-28.xlsx'
+ * @returns string
+ *
+ */
+function getFilenameFromContentDispositionHeader(header) {
+    var contentDisposition = header['content-disposition'];
+    if (!contentDisposition)
+        return '';
+    var filename = contentDisposition.split('filename=')[1].split(';')[0];
+    return decodeURIComponent(filename);
+}
+exports.getFilenameFromContentDispositionHeader = getFilenameFromContentDispositionHeader;

package/dist/index.d.ts

@@ -5,3 +5,4 @@ export * as date from './date';
 export * as types from './types';
 export * as algorithm from './algorithm';
 export * as file from './file';
+export * as support from './support';

package/dist/index.js

@@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.file = exports.algorithm = exports.types = exports.date = exports.dom = exports.react = exports.clipboard = void 0;
+exports.support = exports.file = exports.algorithm = exports.types = exports.date = exports.dom = exports.react = exports.clipboard = void 0;
 exports.clipboard = __importStar(require("./clipboard"));
 exports.react = __importStar(require("./react"));
 exports.dom = __importStar(require("./dom"));
@@ -27,3 +27,4 @@ exports.date = __importStar(require("./date"));
 exports.types = __importStar(require("./types"));
 exports.algorithm = __importStar(require("./algorithm"));
 exports.file = __importStar(require("./file"));
+exports.support = __importStar(require("./support"));

package/dist/support.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 是否是浏览器环境
+ */
+export declare const isBrowserEnv: () => boolean;
+/**
+ * 是否支持WebSocket
+ */
+export declare const isWebSocket: () => boolean;
+/**
+ * 是否支持SharedWorker
+ */
+export declare const isSharedWorker: () => boolean;

package/dist/support.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSharedWorker = exports.isWebSocket = exports.isBrowserEnv = void 0;
+/**
+ * 是否是浏览器环境
+ */
+var isBrowserEnv = function () { return typeof window !== 'undefined'; };
+exports.isBrowserEnv = isBrowserEnv;
+/**
+ * 是否支持WebSocket
+ */
+var isWebSocket = function () { return typeof WebSocket !== 'undefined'; };
+exports.isWebSocket = isWebSocket;
+/**
+ * 是否支持SharedWorker
+ */
+var isSharedWorker = function () { return typeof SharedWorker !== 'undefined'; };
+exports.isSharedWorker = isSharedWorker;

package/dist/types.d.ts

@@ -1 +1,7 @@
+/** 指定的属性变为可选 */
 export declare type WithOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/** 除了 K 的其他属性变成可选 */
+export declare type ExcludePickPartial<T, K extends keyof T> = Partial<Omit<T, K>> & Pick<T, K>;
+export declare type Undefinable<T> = {
+    [K in keyof T]: T[K] | undefined;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-matrix/utils",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "A dozen of utils for Front-End Development",
   "main": "dist/index.js",
   "scripts": {
@@ -8,7 +8,9 @@
     "prebuild": "npm run clean",
     "clean": "rimraf dist",
     "cy:open": "cypress open",
-    "cy:run": "cypress run"
+    "cy:run": "cypress run",
+    "test:tsd": "tsd",
+    "postversion": "git push && git push --tags"
   },
   "engines": {
     "node": ">=16.20.0"
@@ -18,9 +20,12 @@
     "url": "git+https://github.com/mrdulin/dm-utils.git"
   },
   "files": [
-    "dist"
+    "dist",
+    "readme.md"
+  ],
+  "keywords": [
+    "utils"
   ],
-  "keywords": [],
   "author": "Lin Du",
   "license": "MIT",
   "bugs": {
@@ -37,6 +42,7 @@
   "devDependencies": {
     "@vitejs/plugin-react": "^4.2.1",
     "cypress": "^13.6.6",
+    "expect-type": "^0.19.0",
     "rimraf": "^5.0.5",
     "vite": "^4.5.2"
   }

package/readme.md

@@ -12,7 +12,9 @@ A dozen of utils for Front-End Development
 - [dom](#dom)
 - [date](#date)
 - [types](#types)
-- [algorithm]($algorithm)
+- [algorithm](#algorithm)
+- [file](#file)
+- [support](#support)
 
 ### clipboard
 
@@ -115,6 +117,54 @@ interface ImageSizeValidationResult {
 
 图片宽，高校验
 
+- `isImageExists(src: string, img: HTMLImageElement = new Image()): Promise<boolean>`
+
+检测图片地址是否可用
+
+```ts
+import { file } from '@d-matrix/utils';
+
+const url = 'https://picsum.photos/200/300';
+const res = await file.isImageExists(url);
+```
+
+传入HTML中已经存在的`img`元素
+
+```js
+import { file } from '@d-matrix/utils';
+
+const $img = document.getElementById('img');
+const res = await file.isImageExists(url, $img);
+```
+
+- `getFilenameFromContentDispositionHeader(header: { ['content-disposition']: string }): string`
+
+从`Content-Disposition` response header中获取`filename`
+
+```ts
+import { file } from '@d-matrix/utils';
+
+const header = {
+  'content-disposition': 'attachment;filename=%E5%A4%A7%E8%A1%8C%E6%8C%87%E5%AF%BC2024-06-27-2024-06-28.xlsx'
+};
+const filename = file.getFilenameFromContentDispositionHeader(header);
+// '大行指导2024-06-27-2024-06-28.xlsx'
+```
+
+## support
+
+- `isBrowserEnv(): boolean`
+
+是否是浏览器环境
+
+- `isWebSocket(): boolean`
+
+是否支持WebSocket
+
+- `isSharedWorker(): boolean`
+
+是否支持SharedWorker
+
 ## 测试
 
 运行全部组件测试
@@ -143,6 +193,22 @@ npm version <minor> or <major>...
 npm build
 ```
 
+发布：
+
+```bash
+npm publish --access public
+```
+
+镜像站查询版本与手动同步:
+
+[npm镜像站](https://npmmirror.com/package/@d-matrix/utils)
+
+通过`git log`命令获取changelogs，用于填写GitHub Release内容:
+
+```bash
+git log --oneline --decorate
+```
+
 ## 注意事项
 
 - [Before Publishing: Make Sure Your Package Installs and Works](https://docs.npmjs.com/cli/v10/using-npm/developers/#before-publishing-make-sure-your-package-installs-and-works)