util-helpers 4.0.8 → 4.1.0

package/esm/setDataURLPrefix.js

@@ -0,0 +1,28 @@
+/**
+ * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/><br/>
+ *
+ * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
+ *
+ * @static
+ * @alias module:Processor.setDataURLPrefix
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/Data_URIs|Data URLs}
+ * @param {string} data 数据本身
+ * @param {string} [mimetype="image/png"] MIME 类型
+ * @param {boolean} [base64=true] 添加 base64 标识
+ * @returns {string} DataURL 格式的字符串
+ * @example
+ * const data = 'PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
+ * setDataURLPrefix(data); // data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, 'image/png', false); // data:image/png,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, 'image/jpg'); // data:image/jpg;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, 'text/html'); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, ''); // data:;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, '', false); // data:,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ */
+function setDataURLPrefix(data) {
+  var mimetype = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'image/png';
+  var base64 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+  return "data:".concat(mimetype).concat(base64 ? ';base64' : '', ",").concat(data);
+}
+
+export default setDataURLPrefix;

package/lib/blobToDataURL.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+//  file、blob文件如何预览图片？
+//  方法1：将file或者blob类型文件转成base64数据，再作为src赋值给img标签
+//  方法2：使用 window.URL.createObjectURL(blob) 为blob、file 创建一个指向该参数对象的URL
+
+/**
+ * 将 Blob 或 File 对象转成 data:URL 格式的 Base64 字符串。
+ *
+ * @static
+ * @alias module:Processor.blobToDataURL
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader/readAsDataURL|FileReader.readAsDataURL()}
+ * @since 4.1.0
+ * @param {Blob} blob Blob 或 File 对象
+ * @returns {Promise<string>} data:URL 格式的 Base64 字符串。
+ * @example
+ * const aFileParts = ['<a id="a"><b id="b">hey!</b></a>']; // 一个包含DOMString的数组
+ * const htmlBlob = new Blob(aFileParts, { type: 'text/html' }); // 得到 blob
+ *
+ * blobToDataURL(htmlBlob).then(data=>{
+ *   console.log(data); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * });
+ *
+ * const textBlob = new Blob(aFileParts, { type: 'text/plain' });
+ *
+ * blobToDataURL(textBlob).then(data=>{
+ *   console.log(data); // data:text/plain;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * });
+ */
+function blobToDataURL(blob) {
+  return new Promise(function (resolve, reject) {
+    var reader = new FileReader();
+    reader.readAsDataURL(blob); // @ts-ignore
+
+    reader.onload = function () {
+      return resolve(reader.result);
+    };
+
+    reader.onerror = function (error) {
+      return reject(error);
+    };
+  });
+}
+
+var _default = blobToDataURL;
+exports["default"] = _default;

package/lib/dataURLToBlob.js

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+/**
+ * 将 DataURL 转为 Blob 对象
+ *
+ * @static
+ * @alias module:Processor.dataURLToBlob
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Glossary/Base64|Base64}
+ * @since 4.1.0
+ * @param {string} dataurl data: 协议的URL
+ * @returns {Blob} Blob 对象
+ * @example
+ * const dataurl = 'data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
+ * dataURLToBlob(dataurl);
+ */
+function dataURLToBlob(dataurl) {
+  var arr = dataurl.split(','); // @ts-ignore
+
+  var mime = arr[0].match(/:(.*?);/)[1];
+  var bstr = atob(arr[1]);
+  var n = bstr.length;
+  var u8arr = new Uint8Array(n);
+
+  while (n--) {
+    u8arr[n] = bstr.charCodeAt(n);
+  }
+
+  return new Blob([u8arr], {
+    type: mime
+  });
+}
+
+var _default = dataURLToBlob;
+exports["default"] = _default;

package/lib/index.js

@@ -165,6 +165,24 @@ Object.defineProperty(exports, "parseIdCard", {
     return _parseIdCard["default"];
   }
 });
+Object.defineProperty(exports, "blobToDataURL", {
+  enumerable: true,
+  get: function get() {
+    return _blobToDataURL["default"];
+  }
+});
+Object.defineProperty(exports, "dataURLToBlob", {
+  enumerable: true,
+  get: function get() {
+    return _dataURLToBlob["default"];
+  }
+});
+Object.defineProperty(exports, "setDataURLPrefix", {
+  enumerable: true,
+  get: function get() {
+    return _setDataURLPrefix["default"];
+  }
+});
 Object.defineProperty(exports, "plus", {
   enumerable: true,
   get: function get() {
@@ -256,6 +274,12 @@ var _bytesToSize = _interopRequireDefault(require("./bytesToSize"));
 
 var _parseIdCard = _interopRequireDefault(require("./parseIdCard"));
 
+var _blobToDataURL = _interopRequireDefault(require("./blobToDataURL"));
+
+var _dataURLToBlob = _interopRequireDefault(require("./dataURLToBlob"));
+
+var _setDataURLPrefix = _interopRequireDefault(require("./setDataURLPrefix"));
+
 var _plus = _interopRequireDefault(require("./plus"));
 
 var _minus = _interopRequireDefault(require("./minus"));

package/lib/setDataURLPrefix.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+/**
+ * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/><br/>
+ *
+ * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
+ *
+ * @static
+ * @alias module:Processor.setDataURLPrefix
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/Data_URIs|Data URLs}
+ * @param {string} data 数据本身
+ * @param {string} [mimetype="image/png"] MIME 类型
+ * @param {boolean} [base64=true] 添加 base64 标识
+ * @returns {string} DataURL 格式的字符串
+ * @example
+ * const data = 'PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
+ * setDataURLPrefix(data); // data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, 'image/png', false); // data:image/png,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, 'image/jpg'); // data:image/jpg;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, 'text/html'); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, ''); // data:;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, '', false); // data:,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ */
+function setDataURLPrefix(data) {
+  var mimetype = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'image/png';
+  var base64 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+  return "data:".concat(mimetype).concat(base64 ? ';base64' : '', ",").concat(data);
+}
+
+var _default = setDataURLPrefix;
+exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.0.8",
+  "version": "4.1.0",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",

package/types/blobToDataURL.d.ts

@@ -0,0 +1,25 @@
+export default blobToDataURL;
+/**
+ * 将 Blob 或 File 对象转成 data:URL 格式的 Base64 字符串。
+ *
+ * @static
+ * @alias module:Processor.blobToDataURL
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader/readAsDataURL|FileReader.readAsDataURL()}
+ * @since 4.1.0
+ * @param {Blob} blob Blob 或 File 对象
+ * @returns {Promise<string>} data:URL 格式的 Base64 字符串。
+ * @example
+ * const aFileParts = ['<a id="a"><b id="b">hey!</b></a>']; // 一个包含DOMString的数组
+ * const htmlBlob = new Blob(aFileParts, { type: 'text/html' }); // 得到 blob
+ *
+ * blobToDataURL(htmlBlob).then(data=>{
+ *   console.log(data); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * });
+ *
+ * const textBlob = new Blob(aFileParts, { type: 'text/plain' });
+ *
+ * blobToDataURL(textBlob).then(data=>{
+ *   console.log(data); // data:text/plain;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * });
+ */
+declare function blobToDataURL(blob: Blob): Promise<string>;

package/types/dataURLToBlob.d.ts

@@ -0,0 +1,15 @@
+export default dataURLToBlob;
+/**
+ * 将 DataURL 转为 Blob 对象
+ *
+ * @static
+ * @alias module:Processor.dataURLToBlob
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Glossary/Base64|Base64}
+ * @since 4.1.0
+ * @param {string} dataurl data: 协议的URL
+ * @returns {Blob} Blob 对象
+ * @example
+ * const dataurl = 'data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
+ * dataURLToBlob(dataurl);
+ */
+declare function dataURLToBlob(dataurl: string): Blob;

package/types/index.d.ts

@@ -25,6 +25,9 @@ export { default as replaceChar } from "./replaceChar";
 export { default as numberToChinese } from "./numberToChinese";
 export { default as bytesToSize } from "./bytesToSize";
 export { default as parseIdCard } from "./parseIdCard";
+export { default as blobToDataURL } from "./blobToDataURL";
+export { default as dataURLToBlob } from "./dataURLToBlob";
+export { default as setDataURLPrefix } from "./setDataURLPrefix";
 export { default as plus } from "./plus";
 export { default as minus } from "./minus";
 export { default as times } from "./times";

package/types/setDataURLPrefix.d.ts

@@ -0,0 +1,23 @@
+export default setDataURLPrefix;
+/**
+ * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/><br/>
+ *
+ * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
+ *
+ * @static
+ * @alias module:Processor.setDataURLPrefix
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/Data_URIs|Data URLs}
+ * @param {string} data 数据本身
+ * @param {string} [mimetype="image/png"] MIME 类型
+ * @param {boolean} [base64=true] 添加 base64 标识
+ * @returns {string} DataURL 格式的字符串
+ * @example
+ * const data = 'PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
+ * setDataURLPrefix(data); // data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, 'image/png', false); // data:image/png,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, 'image/jpg'); // data:image/jpg;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, 'text/html'); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, ''); // data:;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * setDataURLPrefix(data, '', false); // data:,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ */
+declare function setDataURLPrefix(data: string, mimetype?: string | undefined, base64?: boolean | undefined): string;