util-helpers 4.16.1 → 4.17.0

package/lib/validatePassword.js

@@ -1,270 +1,113 @@
-"use strict";
+'use strict';
+
+var devWarn = require('./utils/devWarn.js');
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-var _devWarn = _interopRequireDefault(require("./utils/devWarn"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 var regNumber = /[\d]/;
 var regLowerCaseLetter = /[a-z]/;
 var regUpperCaseLetter = /[A-Z]/;
 var regAllNumberAndLetter = /[\d|a-z]/gi;
-
-/**
- * 是否包含数字
- *
- * @private
- * @param {string} val 检查的值
- * @returns {boolean} 是否包含数字
- */
 function hasNumber(val) {
-  return regNumber.test(val);
+    return regNumber.test(val);
 }
-
-/**
- * 是否包含小写字母
- *
- * @private
- * @param {string} val 检测的值
- * @returns {boolean} 是否包含小写字母
- */
 function hasLowerCaseLetter(val) {
-  return regLowerCaseLetter.test(val);
+    return regLowerCaseLetter.test(val);
 }
-
-/**
- * 是否包含大写字母
- *
- * @private
- * @param {string} val 检测的值
- * @returns {boolean} 是否包含大写字母
- */
 function hasUpperCaseLetter(val) {
-  return regUpperCaseLetter.test(val);
+    return regUpperCaseLetter.test(val);
 }
-
-/**
- * 是否为十六进制
- *
- * @private
- * @param {string} val 检测的值
- * @returns {boolean} 是否为十六进制
- */
 function hasHex(val) {
-  return val.indexOf('\\x') > -1 || val.indexOf("\\u") > -1;
+    return val.indexOf('\\x') > -1 || val.indexOf('\\u') > -1;
 }
-
-/**
- * 是否包含特殊字符
- *
- * @private
- * @param {string} val 检测的值
- * @param {string} chars 特殊字符
- * @returns {boolean} 是否包含特殊字符
- */
 function hasSpecialCharacter(val, chars) {
-  if (!chars || !val) {
-    return false;
-  }
-  var specialChars = val.replace(regAllNumberAndLetter, '');
-  if (!specialChars) {
-    return false;
-  }
-  var regChars = hasHex(chars) ? new RegExp("[".concat(chars, "]")) : null;
-  if (regChars) {
-    return regChars.test(specialChars);
-  }
-  var ret = false;
-  specialChars.split('').some(function (charItem) {
-    if (chars.indexOf(charItem) > -1) {
-      ret = true;
+    if (!chars || !val) {
+        return false;
+    }
+    var specialChars = val.replace(regAllNumberAndLetter, '');
+    if (!specialChars) {
+        return false;
+    }
+    var regChars = hasHex(chars) ? new RegExp("[".concat(chars, "]")) : null;
+    if (regChars) {
+        return regChars.test(specialChars);
     }
+    var ret = false;
+    specialChars.split('').some(function (charItem) {
+        if (chars.indexOf(charItem) > -1) {
+            ret = true;
+        }
+        return ret;
+    });
     return ret;
-  });
-  return ret;
 }
-
-/**
- * 是否包含非法字符
- *
- * @private
- * @param {string} val 检测的值
- * @param {string} chars 特殊字符
- * @returns {boolean} 是否包含非法字符
- */
 function hasUnallowableCharacter(val, chars) {
-  if (!val) {
-    return false;
-  }
-  var specialChars = val.replace(regAllNumberAndLetter, '');
-  if (!specialChars) {
-    return false;
-  } else if (!chars) {
-    return true;
-  }
-  var regChars = hasHex(chars) ? new RegExp("[^".concat(chars, "]")) : null;
-  if (regChars) {
-    return regChars.test(specialChars);
-  }
-  var ret = false;
-  specialChars.split('').some(function (charItem) {
-    if (chars.indexOf(charItem) === -1) {
-      ret = true;
+    if (!val) {
+        return false;
+    }
+    var specialChars = val.replace(regAllNumberAndLetter, '');
+    if (!specialChars) {
+        return false;
     }
+    else if (!chars) {
+        return true;
+    }
+    var regChars = hasHex(chars) ? new RegExp("[^".concat(chars, "]")) : null;
+    if (regChars) {
+        return regChars.test(specialChars);
+    }
+    var ret = false;
+    specialChars.split('').some(function (charItem) {
+        if (chars.indexOf(charItem) === -1) {
+            ret = true;
+        }
+        return ret;
+    });
     return ret;
-  });
-  return ret;
 }
-
-/**
- * @typedef {Object} PasswordContaines - 验证密码的包含内容
- * @property {boolean} number - 包含数字
- * @property {boolean} lowerCaseLetter - 包含小写字母
- * @property {boolean} upperCaseLetter - 包含大写字母
- * @property {boolean} specialCharacter - 包含特殊字符
- * @property {boolean} unallowableCharacter - 包含非法字符
- */
-
-/**
- * @typedef {Object} ValidatePasswordReturn - 验证结果
- * @property {boolean} validated - 验证结果，根据密码强度、是否包含非法字符得出
- * @property {number} level - 强度级别，包含数字/大小写字母/特殊字符
- * @property {PasswordContaines} containes - 包含内容
- */
-
-/**
- * 验证密码（数字、大小写字母、特殊字符、非法字符）
- *
- * @static
- * @alias module:Validator.validatePassword
- * @since 3.7.0
- * @see {@link https://baike.baidu.com/item/ASCII#3|ASCII}
- * @param {string} value 要检测的值
- * @param {Object} [options] 配置项
- * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
- * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，为 ture 时，大小写字母视为一种字符
- * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符
- * @returns {ValidatePasswordReturn} 验证结果
- * @example
- *
- * validatePassword('a12345678');
- * // =>
- * {
- *   validated: true, // 验证结果，根据密码强度、是否包含非法字符得出
- *   level: 2, // 强度级别
- *   containes: {
- *     number: true, // 包含数字
- *     lowerCaseLetter: true, // 包含小写字母
- *     upperCaseLetter: false, // 包含大写字母
- *     specialCharacter: false, // 包含特殊字符
- *     unallowableCharacter: false // 包含非法字符
- *   }
- * }
- *
- * validatePassword('a12345678', { level: 3 });
- * // =>
- * {
- *   validated: false,
- *   level: 2,
- *   containes: {
- *     number: true,
- *     lowerCaseLetter: true,
- *     upperCaseLetter: false,
- *     specialCharacter: false,
- *     unallowableCharacter: false
- *   }
- * }
- *
- * validatePassword('_Aa一二三45678', { level: 3, ignoreCase: true });
- * // =>
- * {
- *   validated: false,
- *   level: 3,
- *   containes: {
- *     number: true,
- *     lowerCaseLetter: true,
- *     upperCaseLetter: true,
- *     specialCharacter: true,
- *     unallowableCharacter: true
- *   }
- * }
- *
- * // 自定义特殊字符
- * validatePassword('_Aa一二三45678', { level: 3, ignoreCase: true, special: '_一二三' });
- * // =>
- * {
- *   validated: true,
- *   level: 3,
- *   containes: {
- *     number: true,
- *     lowerCaseLetter: true,
- *     upperCaseLetter: true,
- *     specialCharacter: true,
- *     unallowableCharacter: false
- *   }
- * }
- */
-function validatePassword(value) {
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var _options$level = options.level,
-    level = _options$level === void 0 ? 2 : _options$level,
-    _options$ignoreCase = options.ignoreCase,
-    ignoreCase = _options$ignoreCase === void 0 ? false : _options$ignoreCase,
-    _options$special = options.special,
-    special = _options$special === void 0 ? '\\x21-\\x2F\\x3A-\\x40\\x5B-\\x60\\x7B-\\x7E' : _options$special;
-  var valStr = value;
-  if (typeof value !== 'string') {
-    (0, _devWarn["default"])("[validatePassword] value must be a string.");
-    valStr = '';
-  }
-  var currentLevel = 0;
-
-  // 包含数字
-  var containesNumber = hasNumber(valStr);
-  // 包含小写字母
-  var containesLowerCaseLetter = hasLowerCaseLetter(valStr);
-  // 包含大写字母
-  var containesUpperCaseLetter = hasUpperCaseLetter(valStr);
-  // 包含特殊字符
-  var containesSpecialCharacter = hasSpecialCharacter(valStr, special);
-  // 包含非法字符，即含有非数字字母特殊字符以外的其他字符
-  var containesUnallowableCharacter = hasUnallowableCharacter(valStr, special);
-  if (containesNumber) {
-    currentLevel += 1;
-  }
-
-  // 不区分大小写
-  if (ignoreCase) {
-    if (containesLowerCaseLetter || containesUpperCaseLetter) {
-      currentLevel += 1;
+function validatePassword(value, options) {
+    if (options === void 0) { options = {}; }
+    var _a = options.level, level = _a === void 0 ? 2 : _a, _b = options.ignoreCase, ignoreCase = _b === void 0 ? false : _b, _c = options.special, special = _c === void 0 ? '\\x21-\\x2F\\x3A-\\x40\\x5B-\\x60\\x7B-\\x7E' : _c;
+    var valStr = value;
+    if (typeof value !== 'string') {
+        devWarn("[validatePassword] value must be a string.");
+        valStr = '';
     }
-  } else {
-    // 区分大小写
-    if (containesLowerCaseLetter) {
-      currentLevel += 1;
+    var currentLevel = 0;
+    var containesNumber = hasNumber(valStr);
+    var containesLowerCaseLetter = hasLowerCaseLetter(valStr);
+    var containesUpperCaseLetter = hasUpperCaseLetter(valStr);
+    var containesSpecialCharacter = hasSpecialCharacter(valStr, special);
+    var containesUnallowableCharacter = hasUnallowableCharacter(valStr, special);
+    if (containesNumber) {
+        currentLevel += 1;
     }
-    if (containesUpperCaseLetter) {
-      currentLevel += 1;
+    if (ignoreCase) {
+        if (containesLowerCaseLetter || containesUpperCaseLetter) {
+            currentLevel += 1;
+        }
     }
-  }
-  if (containesSpecialCharacter) {
-    currentLevel += 1;
-  }
-
-  // 验证结果
-  var validated = currentLevel >= level && !containesUnallowableCharacter;
-  return {
-    validated: validated,
-    level: currentLevel,
-    containes: {
-      number: containesNumber,
-      lowerCaseLetter: containesLowerCaseLetter,
-      upperCaseLetter: containesUpperCaseLetter,
-      specialCharacter: containesSpecialCharacter,
-      unallowableCharacter: containesUnallowableCharacter
+    else {
+        if (containesLowerCaseLetter) {
+            currentLevel += 1;
+        }
+        if (containesUpperCaseLetter) {
+            currentLevel += 1;
+        }
     }
-  };
+    if (containesSpecialCharacter) {
+        currentLevel += 1;
+    }
+    var validated = currentLevel >= level && !containesUnallowableCharacter;
+    return {
+        validated: validated,
+        level: currentLevel,
+        containes: {
+            number: containesNumber,
+            lowerCaseLetter: containesLowerCaseLetter,
+            upperCaseLetter: containesUpperCaseLetter,
+            specialCharacter: containesSpecialCharacter,
+            unallowableCharacter: containesUnallowableCharacter
+        }
+    };
 }
-var _default = validatePassword;
-exports["default"] = _default;
+
+module.exports = validatePassword;

package/lib/waitTime.js

@@ -1,34 +1,10 @@
-"use strict";
+'use strict';
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-/**
- * 等待时间返回 Promise 。常用于异步方法中延时。
- *
- * @static
- * @alias module:Other.waitTime
- * @since 4.2.0
- * @param {number} [time=1000] 延时时间，单位毫秒
- * @returns {Promise<void>}
- * @example
- * 
- * const test = async ()=>{
- *   await waitTime();
- *   // do something
- * }
- *
- * waitTime(500).then(()=>{
- *   // do something
- * });
- * 
- */
-function waitTime() {
-  var time = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1000;
-  return new Promise(function (resolve) {
-    setTimeout(resolve, time);
-  });
+function waitTime(time) {
+    if (time === void 0) { time = 1000; }
+    return new Promise(function (resolve) {
+        setTimeout(resolve, time);
+    });
 }
-var _default = waitTime;
-exports["default"] = _default;
+
+module.exports = waitTime;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.16.1",
+  "version": "4.17.0",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -15,22 +15,19 @@
     "test:type": "jest --verbose test/type",
     "test:validator": "jest --verbose test/validator",
     "test:processor": "jest --verbose test/processor",
-    "build": "npm run build:lib && npm run build:esm && npm run build:dist && npm run types",
-    "build:lib": "rm -rf lib && cross-env MODULE_TYPE=cjs babel src --out-dir lib",
-    "build:esm": "rm -rf esm && cross-env MODULE_TYPE=esm babel src --out-dir esm",
-    "build:dist": "rm -rf dist && rollup -c",
+    "build": "npm run build:module && npm run build:dist && npm run build:types",
+    "build:module": "rm -rf esm && rm -rf lib && rollup -c rollup.module.config.mjs",
+    "build:dist": "rm -rf dist && rollup -c rollup.umd.config.mjs",
+    "build:types": "rm -rf types && tsc -d --outDir types --emitDeclarationOnly",
     "build:doc": "npm run doc",
-    "doc": "rm -rf docs && jsdoc -c conf.json",
+    "doc": "rm -rf docs && rm -rf docs-src && tsc --outDir docs-src && jsdoc -c conf.json && rm -rf docs-src",
     "doc:open": "open ./docs/index.html",
-    "prettier": "prettier --write 'src/**/*.js' && prettier --write 'test/**/*.js'",
-    "lint-staged": "lint-staged",
-    "lint-staged:js": "eslint --ext .js",
+    "prettier": "prettier --write 'src/**/*.ts' && prettier --write 'test/**/*.ts'",
     "precommit": "lint-staged",
-    "lint": "eslint src --ext .js",
-    "lint:fix": "eslint src --ext .js --fix",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
     "commit": "cz",
-    "prepublishOnly": "npm test && npm run build",
-    "types": "rm -rf types && tsc"
+    "prepublishOnly": "npm test && npm run build"
   },
   "repository": {
     "type": "git",
@@ -57,38 +54,37 @@
   },
   "homepage": "https://doly-dev.github.io/util-helpers/index.html",
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.0",
-    "@babel/plugin-transform-modules-commonjs": "^7.14.0",
-    "@babel/plugin-transform-runtime": "^7.13.15",
-    "@babel/preset-env": "^7.9.0",
-    "@babel/preset-typescript": "^7.18.6",
+    "@babel/core": "^7.21.4",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/preset-typescript": "^7.21.4",
     "@commitlint/cli": "^11.0.0",
     "@commitlint/config-conventional": "^11.0.0",
-    "@rollup/plugin-babel": "^5.3.1",
-    "@rollup/plugin-commonjs": "^19.0.0",
-    "@rollup/plugin-node-resolve": "^13.0.0",
-    "@rollup/plugin-replace": "^5.0.1",
-    "@types/jest": "^29.2.4",
-    "babel-jest": "^29.3.1",
+    "@rollup/plugin-commonjs": "^24.1.0",
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-replace": "^5.0.2",
+    "@rollup/plugin-terser": "^0.4.1",
+    "@rollup/plugin-typescript": "^11.1.0",
+    "@types/jest": "^29.5.1",
+    "@typescript-eslint/eslint-plugin": "^5.59.1",
+    "@typescript-eslint/parser": "^5.59.1",
+    "babel-jest": "^29.5.0",
     "babel-plugin-minify-replace": "^0.5.0",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "docdash": "^1.2.0",
-    "eslint": "^7.32.0",
+    "eslint": "^8.39.0",
     "husky": "^4.3.6",
-    "jest": "^29.3.1",
-    "jest-environment-jsdom": "^29.3.1",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
     "jsdoc": "^3.6.3",
     "lint-staged": "^11.1.2",
-    "prettier": "^2.3.2",
-    "rollup": "^2.49.0",
-    "rollup-plugin-terser": "^7.0.2",
+    "prettier": "^2.8.8",
+    "rollup": "^3.21.0",
     "typescript": "^5.0.4"
   },
   "lint-staged": {
-    "**/*.js": "npm run lint-staged:js",
-    "**/*.{js,md}": "prettier --write"
+    "**/*.ts": "eslint",
+    "**/*.{js,ts,md}": "prettier --write"
   },
   "husky": {
     "hooks": {
@@ -101,6 +97,6 @@
     }
   },
   "dependencies": {
-    "@babel/runtime": "^7.14.0"
+    "tslib": "^2.5.0"
   }
 }

package/types/ajax.d.ts

@@ -1,101 +1,43 @@
-export default ajax;
-/**
- * XMLHttpRequest 事件对象
- */
-export type XMLHttpRequestEvent = XMLHttpRequest['onloadstart'];
-/**
- * ajax配置项
- */
-export type AjaxOptions = {
-    /**
-     * 创建请求时使用的方法
-     */
-    method?: string | undefined;
-    /**
-     * 请求体被发送的数据
-     */
-    data?: Document | XMLHttpRequestBodyInit | null | undefined;
-    /**
-     * 自定义请求头
-     */
-    headers?: {
-        [x: string]: string;
-    } | undefined;
-    /**
-     * 响应类型
-     */
-    responseType?: XMLHttpRequestResponseType | undefined;
-    /**
-     * 请求超时的毫秒数
-     */
-    timeout?: number | undefined;
-    /**
-     * 跨域请求时是否需要使用凭证
-     */
-    withCredentials?: boolean | undefined;
-    /**
-     * 是否异步执行操作
-     */
-    async?: boolean | undefined;
-    /**
-     * 用户名，用于认证用途
-     */
-    user?: string | null | undefined;
-    /**
-     * 密码，用于认证用途
-     */
-    password?: string | null | undefined;
-    /**
-     * 接收到响应数据时触发
-     */
-    onLoadStart?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
-    /**
-     * 请求接收到更多数据时，周期性地触发
-     */
-    onProgress?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
-    /**
-     * 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时
-     */
-    onAbort?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
-    /**
-     * 在预设时间内没有接收到响应时触发
-     */
-    onTimeout?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
-    /**
-     * 当 request 遭遇错误时触发
-     */
-    onError?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
-    /**
-     * 请求成功完成时触发
-     */
-    onLoad?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
-    /**
-     * 请求结束时触发，无论请求成功 (load) 还是失败 (abort 或 error)
-     */
-    onLoadEnd?: ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any) | null | undefined;
+type XMLHttpRequestListener = XMLHttpRequest['onloadstart'];
+type AjaxOptions = {
+    method?: string;
+    async?: boolean;
+    user?: string | null;
+    password?: string | null;
+    data?: Parameters<XMLHttpRequest['send']>[0];
+    headers?: Record<string, string>;
+    responseType?: XMLHttpRequestResponseType;
+    timeout?: number;
+    withCredentials?: boolean;
+    onReadyStateChange?: XMLHttpRequest['onreadystatechange'];
+    onLoadStart?: XMLHttpRequestListener;
+    onProgress?: XMLHttpRequestListener;
+    onAbort?: XMLHttpRequestListener;
+    onTimeout?: XMLHttpRequestListener;
+    onError?: XMLHttpRequestListener;
+    onLoad?: XMLHttpRequestListener;
+    onLoadEnd?: XMLHttpRequestListener;
 };
 /**
- * @typedef {XMLHttpRequest['onloadstart']} XMLHttpRequestEvent XMLHttpRequest 事件对象
- */
-/**
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
- * @typedef {Object} AjaxOptions ajax配置项
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest | XMLHttpRequest}
+ * @typedef {Object} AjaxOptions ajax 配置项
  * @property {string} [method="get"] 创建请求时使用的方法
- * @property {Document | XMLHttpRequestBodyInit | null} [data=null] 请求体被发送的数据
- * @property {Object.<string, string>} [headers] 自定义请求头
- * @property {XMLHttpRequestResponseType} [responseType] 响应类型
- * @property {number} [timeout] 请求超时的毫秒数
- * @property {boolean} [withCredentials=false] 跨域请求时是否需要使用凭证
  * @property {boolean} [async=true] 是否异步执行操作
  * @property {string|null} [user=null] 用户名，用于认证用途
  * @property {string|null} [password=null] 密码，用于认证用途
- * @property {XMLHttpRequestEvent} [onLoadStart] 接收到响应数据时触发
- * @property {XMLHttpRequestEvent} [onProgress] 请求接收到更多数据时，周期性地触发
- * @property {XMLHttpRequestEvent} [onAbort] 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时
- * @property {XMLHttpRequestEvent} [onTimeout] 在预设时间内没有接收到响应时触发
- * @property {XMLHttpRequestEvent} [onError] 当 request 遭遇错误时触发
- * @property {XMLHttpRequestEvent} [onLoad] 请求成功完成时触发
- * @property {XMLHttpRequestEvent} [onLoadEnd] 请求结束时触发，无论请求成功 (load) 还是失败 (abort 或 error)
+ * @property {object} [headers] 自定义请求头
+ * @property {string} [responseType] 响应类型
+ * @property {number} [timeout] 请求超时的毫秒数
+ * @property {boolean} [withCredentials=false] 跨域请求时是否需要使用凭证
+ * @property {*} [data=null] 请求体被发送的数据
+ * @property {function} [options.onReadyStateChange] 当 readyState 属性发生变化时触发
+ * @property {function} [onLoadStart] 接收到响应数据时触发
+ * @property {function} [onProgress] 请求接收到更多数据时，周期性地触发
+ * @property {function} [onAbort] 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时
+ * @property {function} [onTimeout] 在预设时间内没有接收到响应时触发
+ * @property {function} [onError] 当 request 遭遇错误时触发
+ * @property {function} [onLoad] 请求成功完成时触发
+ * @property {function} [onLoadEnd] 请求结束时触发，无论请求成功 (load) 还是失败 (abort 或 error)
  */
 /**
  * 请求<br/><br/>
@@ -105,10 +47,10 @@ export type AjaxOptions = {
  * @static
  * @alias module:Other.ajax
  * @since 4.16.0
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest | XMLHttpRequest}
  * @param {string} url 地址
  * @param {AjaxOptions} [options] 配置项
- * @returns {Promise<ProgressEvent<EventTarget>>}
+ * @returns {Promise<object>} XHR 事件对象
  * @example
  * ajax('/somefile').then(res=>{
  *   // do something
@@ -118,4 +60,5 @@ export type AjaxOptions = {
  *   // do something
  * });
  */
-declare function ajax(url: string, options?: AjaxOptions | undefined): Promise<ProgressEvent<EventTarget>>;
+declare function ajax(url: string, options?: AjaxOptions): Promise<ProgressEvent<EventTarget>>;
+export default ajax;