@ivujs/i-utils 2.0.0 → 2.1.0

package/dist/es/url/index.d.ts

@@ -1,118 +1,118 @@
 /**
  * 获得协议名
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回协议名
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回协议名
  */
-export function getProtocol(url?: string): string;
+export declare function getProtocol(url?: string): string | undefined;
 /**
  * 获得主机地址
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回主机地址
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回主机地址
  */
-export function getHost(url?: string): string;
+export declare function getHost(url?: string): string | undefined;
 /**
  * 获得主机名称
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回主机名称
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回主机名称
  */
-export function getHostName(url?: string): string;
+export declare function getHostName(url?: string): string | undefined;
 /**
  * 获得端口号
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回端口号
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回端口号
  */
-export function getPort(url?: string): string;
+export declare function getPort(url?: string): string | undefined;
 /**
  * 获得地址路径
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回地址路径
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回地址路径
  */
-export function getUrlPath(url?: string): string;
+export declare function getUrlPath(url?: string): string | undefined;
 /**
  * 获得hash字符串
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回hash字符串
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回hash字符串
  */
-export function getUrlHash(url?: string): string;
+export declare function getUrlHash(url?: string): string | undefined;
 /**
  * 获得查询参数字符串
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回查询参数字符串
  */
-export function getSearchString(url?: string): string;
+export declare function getSearchString(url?: string): string | undefined;
 /**
  * 查询参数字符串中是否包含某个参数
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @returns {Boolean} 返回结果
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @returns {boolean} 返回结果
  */
-export function hasSearchParam(url: string, name: string): boolean;
+export declare function hasSearchParam(url: string | undefined, name: string): boolean;
 /**
  * 查询参数字符串中获得某个参数的值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @returns {String} 返回查询到的值
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @returns {string} 返回查询到的值
  */
-export function getSearchParam(url?: string, name?: string): string;
+export declare function getSearchParam(url?: string, name?: string): string | undefined;
 /**
  * 查询参数字符串中设置某个参数的值
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回查询参数字符串
+ * @param {string} name 参数名
+ * @param {string|number|Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回查询参数字符串
  */
-export function setSearchParam(url: string, name: string, value: any): string;
+export declare function setSearchParam(url: string | undefined, name: string | undefined, value: string | number | number[] | string[]): string;
 /**
  * 查询参数字符串转为对象
- * @param {String} url url地址，默认当前url地址
+ * @param {string} url url地址，默认当前url地址
  * @returns {Object} 返回参数对象
  */
-export function parseSearchParam(url?: string): Object;
+export declare function parseSearchParam(url?: string): Record<string, any>;
 /**
  * 对象转为查询参数字符串
  *  @param {Object} params 参数对象
- *  @param {String} url url地址，如果不为空，则会拼接好查询参数字符串的url地址
- *  @returns {String,Object} 返回参数字符串或参数对象
+ *  @param {string} url url地址，如果不为空，则会拼接好查询参数字符串的url地址
+ *  @returns {string} 返回参数字符串
  */
-export function stringifySearchParam(params: Object, url?: string): string;
+export declare function stringifySearchParam(params: Record<string, any>, url?: string): string;
 /**
  * 查询参数字符串中在最前面追加新参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @param {string|number|Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @returns {string} 返回查询参数字符串
  */
-export function prependSearchParam(url: string, name: string, value: any): string;
+export declare function prependSearchParam(url: string | undefined, name: string, value: string | number | number[] | string[]): string;
 /**
  * 查询参数字符串中在某个参数的前面追加新参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @param {String} beforeParam 在前面追加参数的名称
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @param {string|number|Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @param {string} beforeParam 在前面追加参数的名称
+ * @returns {string} 返回查询参数字符串
  */
-export function prependToSearchParam(url: string, beforeParam: string, name: string, value: any): string;
+export declare function prependToSearchParam(url: string | undefined, beforeParam: string, name: string, value: string | number | number[] | string[]): string;
 /**
  * 查询参数字符串中在最后面追加新参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @param {string,number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @returns {string} 返回查询参数字符串
  */
-export function appendSearchParam(url: string, name: string, value: any): string;
+export declare function appendSearchParam(url: string | undefined, name: string, value: string | number | number[] | string[]): string;
 /**
  * 查询参数字符串中在某个参数的后面追加新参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @param {String} afterName 在后面追加参数的名称
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @param {string,number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @param {string} afterName 在后面追加参数的名称
+ * @returns {string} 返回查询参数字符串
  */
-export function appendToSearchParam(url: string, afterName: string, name: string, value: any): string;
+export declare function appendToSearchParam(url: string | undefined, afterName: string, name: string, value: string | number | number[] | string[]): string;
 /**
  * 查询参数字符串中移除某个参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @returns {string} 返回查询参数字符串
  */
-export function removeSearchParam(url: string, name: string): string;
+export declare function removeSearchParam(url: string | undefined, name: string): string;

package/dist/es/url/index.mjs

@@ -2,132 +2,135 @@ import { REGEXP } from '../constants/regexp.mjs';
 import { isArray } from '../validate/index.mjs';
 import { arrayInsertBefore, arrayInsertAfter } from '../array/index.mjs';
 
+/**
+ * @module 浏览器Url
+ */
 /**
  * 获得协议名
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回协议名
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回协议名
  */
 function getProtocol(url = window.location.href) {
-    let match = url.match(REGEXP.URL);
+    const match = url.match(REGEXP.URL);
     if (match) {
         return match[1] || "";
     }
 }
 /**
  * 获得主机地址
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回主机地址
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回主机地址
  */
 function getHost(url = window.location.href) {
-    let match = url.match(REGEXP.URL);
+    const match = url.match(REGEXP.URL);
     if (match) {
         return (match[2] || "") + (match[3] ? ":" + match[3] : "");
     }
 }
 /**
  * 获得主机名称
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回主机名称
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回主机名称
  */
 function getHostName(url = window.location.href) {
-    let match = url.match(REGEXP.URL);
+    const match = url.match(REGEXP.URL);
     if (match) {
         return match[2] || "";
     }
 }
 /**
  * 获得端口号
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回端口号
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回端口号
  */
 function getPort(url = window.location.href) {
-    let match = url.match(REGEXP.URL);
+    const match = url.match(REGEXP.URL);
     if (match) {
         return match[3] || "";
     }
 }
 /**
  * 获得地址路径
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回地址路径
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回地址路径
  */
 function getUrlPath(url = window.location.href) {
-    let match = url.match(REGEXP.URL);
+    const match = url.match(REGEXP.URL);
     if (match) {
         return match[4] || "";
     }
 }
 /**
  * 获得hash字符串
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回hash字符串
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回hash字符串
  */
 function getUrlHash(url = window.location.href) {
-    let match = url.match(REGEXP.URL);
+    const match = url.match(REGEXP.URL);
     if (match) {
         return match[6] || "";
     }
 }
 /**
  * 获得查询参数字符串
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回查询参数字符串
  */
 function getSearchString(url = window.location.href) {
-    let match = url.match(REGEXP.URL);
+    const match = url.match(REGEXP.URL);
     if (match) {
         return match[5] || "";
     }
 }
 /**
  * 查询参数字符串中是否包含某个参数
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @returns {Boolean} 返回结果
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @returns {boolean} 返回结果
  */
 function hasSearchParam(url = window.location.href, name) {
-    let params = parseSearchParam(url);
+    const params = parseSearchParam(url);
     return params[name] !== undefined;
 }
 /**
  * 查询参数字符串中获得某个参数的值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @returns {String} 返回查询到的值
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @returns {string} 返回查询到的值
  */
 function getSearchParam(url = window.location.href, name = "") {
     name = name.replace(/[[\]]/g, "\\$&");
-    url = getSearchString(url);
-    let reg = new RegExp("(^|&)" + name + "=([^&]*)(&|$)");
-    let match = url.substring(0).match(reg);
+    url = getSearchString(url) || "";
+    const reg = new RegExp("(^|&)" + name + "=([^&]*)(&|$)");
+    const match = url.substring(0).match(reg);
     if (match) {
         return decodeURIComponent(match[2]);
     }
 }
 /**
  * 查询参数字符串中设置某个参数的值
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @param {String} url url地址，默认当前url地址
- * @returns {String} 返回查询参数字符串
+ * @param {string} name 参数名
+ * @param {string|number|Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @param {string} url url地址，默认当前url地址
+ * @returns {string} 返回查询参数字符串
  */
 function setSearchParam(url = window.location.href, name = "", value) {
-    let params = parseSearchParam(url);
+    const params = parseSearchParam(url);
     params[name] = value;
     // 返回替换后的url
     return url.replace(/(\?.+?)(?=#|$)/, "?" + stringifySearchParam(params));
 }
 /**
  * 查询参数字符串转为对象
- * @param {String} url url地址，默认当前url地址
+ * @param {string} url url地址，默认当前url地址
  * @returns {Object} 返回参数对象
  */
 function parseSearchParam(url = window.location.href) {
-    let searchString = getSearchString(url);
-    let searchArr = searchString.split("&");
-    let param = {};
+    const searchString = getSearchString(url) || "";
+    const searchArr = searchString.split("&");
+    const param = {};
     for (let i = 0; i < searchArr.length; i++) {
-        let arr = searchArr[i].split("=");
+        const arr = searchArr[i].split("=");
         param[decodeURIComponent(arr[0])] = decodeURIComponent(arr[1] || "");
     }
     return param;
@@ -135,15 +138,15 @@ function parseSearchParam(url = window.location.href) {
 /**
  * 对象转为查询参数字符串
  *  @param {Object} params 参数对象
- *  @param {String} url url地址，如果不为空，则会拼接好查询参数字符串的url地址
- *  @returns {String,Object} 返回参数字符串或参数对象
+ *  @param {string} url url地址，如果不为空，则会拼接好查询参数字符串的url地址
+ *  @returns {string} 返回参数字符串
  */
-function stringifySearchParam(params, url = undefined) {
+function stringifySearchParam(params, url = "") {
     if (typeof params !== "object")
         return params;
-    let arr = [];
-    for (let key in params) {
-        let value = params[key];
+    const arr = [];
+    for (const key in params) {
+        const value = params[key];
         if (isArray(value)) {
             for (let i = 0; i < value.length; ++i) {
                 arr.push(encodeURIComponent(key + "[" + i + "]") + "=" + encodeURIComponent(value[i]));
@@ -163,15 +166,15 @@ function stringifySearchParam(params, url = undefined) {
 }
 /**
  * 查询参数字符串中在最前面追加新参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @param {string|number|Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @returns {string} 返回查询参数字符串
  */
 function prependSearchParam(url = window.location.href, name, value) {
-    let searchArr = getSearchString(url).split("&");
-    if (isArray(value)) {
-        let arr = [];
+    const searchArr = (getSearchString(url) || "").split("&") || [];
+    if (Array.isArray(value)) {
+        const arr = [];
         for (let i = 0; i < value.length; i++) {
             arr.push(`${encodeURIComponent(name)}[${i}]=${encodeURIComponent(value[i])}`);
         }
@@ -184,53 +187,53 @@ function prependSearchParam(url = window.location.href, name, value) {
 }
 /**
  * 查询参数字符串中在某个参数的前面追加新参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @param {String} beforeParam 在前面追加参数的名称
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @param {string|number|Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @param {string} beforeParam 在前面追加参数的名称
+ * @returns {string} 返回查询参数字符串
  */
 function prependToSearchParam(url = window.location.href, beforeParam, name, value) {
-    let searchArr = getSearchString(url).split("&");
-    let beforeIndex = searchArr.findIndex((v) => v.includes(beforeParam));
-    let beforeArr = arrayInsertBefore(searchArr, beforeIndex, `${name}=${value}`);
+    const searchArr = (getSearchString(url) || "").split("&");
+    const beforeIndex = searchArr.findIndex((v) => v.includes(beforeParam));
+    const beforeArr = arrayInsertBefore(searchArr, beforeIndex, `${name}=${value}`);
     return url.replace(/(\?.+?)(?=#|$)/, "?" + beforeArr.join("&"));
 }
 /**
  * 查询参数字符串中在最后面追加新参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @param {string,number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @returns {string} 返回查询参数字符串
  */
 function appendSearchParam(url = window.location.href, name, value) {
-    let searchArr = getSearchString(url).split("&");
+    const searchArr = (getSearchString(url) || "").split("&");
     searchArr.push(`${name}=${value}`);
     return url.replace(/(\?.+?)(?=#|$)/, "?" + searchArr.join("&"));
 }
 /**
  * 查询参数字符串中在某个参数的后面追加新参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @param {String,Number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
- * @param {String} afterName 在后面追加参数的名称
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @param {string,number,Array} value 参数值，如果是数组，则解析为：&ids[0]=1&ids[2]=2
+ * @param {string} afterName 在后面追加参数的名称
+ * @returns {string} 返回查询参数字符串
  */
 function appendToSearchParam(url = window.location.href, afterName, name, value) {
-    let searchArr = getSearchString(url).split("&");
-    let beforeIndex = searchArr.findIndex((v) => v.includes(afterName));
-    let afterArr = arrayInsertAfter(searchArr, beforeIndex, `${name}=${value}`);
+    const searchArr = (getSearchString(url) || "").split("&");
+    const beforeIndex = searchArr.findIndex((v) => v.includes(afterName));
+    const afterArr = arrayInsertAfter(searchArr, beforeIndex, `${name}=${value}`);
     return url.replace(/(\?.+?)(?=#|$)/, "?" + afterArr.join("&"));
 }
 /**
  * 查询参数字符串中移除某个参数和值
- * @param {String} url url地址，默认当前url地址
- * @param {String} name 参数名
- * @returns {String} 返回查询参数字符串
+ * @param {string} url url地址，默认当前url地址
+ * @param {string} name 参数名
+ * @returns {string} 返回查询参数字符串
  */
 function removeSearchParam(url = window.location.href, name) {
-    let searchArr = getSearchString(url).split("&");
-    let delIndex = searchArr.findIndex((v) => v.includes(name));
+    const searchArr = (getSearchString(url) || "").split("&");
+    const delIndex = searchArr.findIndex((v) => v.includes(name));
     if (delIndex > -1) {
         searchArr.splice(delIndex, 1);
     }