@ivujs/i-utils/dist/es/url/index.d.ts

前端模块化 JavaScript 工具库

/**
 * 获得协议名
 * @param {string} url url地址，默认当前url地址
 * @returns {string} 返回协议名
 */
export declare function getProtocol(url?: string): string | undefined;
/**
 * 获得主机地址
 * @param {string} url url地址，默认当前url地址
 * @returns {string} 返回主机地址
 */
export declare function getHost(url?: string): string | undefined;
/**
 * 获得主机名称
 * @param {string} url url地址，默认当前url地址
 * @returns {string} 返回主机名称
 */
export declare function getHostName(url?: string): string | undefined;
/**
 * 获得端口号
 * @param {string} url url地址，默认当前url地址
 * @returns {string} 返回端口号
 */
export declare function getPort(url?: string): string | undefined;
/**
 * 获得地址路径
 * @param {string} url url地址，默认当前url地址
 * @returns {string} 返回地址路径
 */
export declare function getUrlPath(url?: string): string | undefined;
/**
 * 获得hash字符串
 * @param {string} url url地址，默认当前url地址
 * @returns {string} 返回hash字符串
 */
export declare function getUrlHash(url?: string): string | undefined;
/**
 * 获得查询参数字符串
 * @param {string} url url地址，默认当前url地址
 * @returns {string} 返回查询参数字符串
 */
export declare function getSearchString(url?: string): string | undefined;
/**
 * 查询参数字符串中是否包含某个参数
 * @param {string} url url地址，默认当前url地址
 * @param {string} name 参数名
 * @returns {boolean} 返回结果
 */
export declare function hasSearchParam(url: string | undefined, name: string): boolean;
/**
 * 查询参数字符串中获得某个参数的值
 * @param {string} url url地址，默认当前url地址
 * @param {string} name 参数名
 * @returns {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} 返回查询参数字符串
 */
export declare function setSearchParam(url: string | undefined, name: string | undefined, value: string | number | number[] | string[]): string;
/**
 * 查询参数字符串转为对象
 * @param {string} url url地址，默认当前url地址
 * @returns {Object} 返回参数对象
 */
export declare function parseSearchParam(url?: string): Record<string, any>;
/**
 * 对象转为查询参数字符串
 *  @param {Object} params 参数对象
 *  @param {string} url url地址，如果不为空，则会拼接好查询参数字符串的url地址
 *  @returns {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} 返回查询参数字符串
 */
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} 返回查询参数字符串
 */
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} 返回查询参数字符串
 */
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} 返回查询参数字符串
 */
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} 返回查询参数字符串
 */
export declare function removeSearchParam(url: string | undefined, name: string): string;