@zstings/utils/dist/types/src/url/getUrlParam.d.ts

javascript、typescript 工具函数库 文档地址 [utils 文档](https://zstings.github.io/utils/)

/**
 * 获取url上的参数
 * @param name 参数名，必填
 * @param url url地址，为空时是window.location.href， 非必填
 * @throws url 参数错误，不是有效的
 * @return 符合的值或者null
 * @category URL
 * @example
 * 支持search和hash中取值，如果search和hash中有相同的参数，则默认使用search。
 * 不传值时，默认从window.location.href中取值
 * ```ts
 * getUrlParam('id') => 'a' // window.location.href: https://a.b.com/?id=a
 * ```
 * @example
 * 从第二个参数的url上取值
 * ```ts
 * getUrlParam('id', 'https://a.b.com/?id=b') => 'b'
 * ```
 * @example
 * 在第二个参数的url上优先从search中提取值。
 * ```ts
 * getUrlParam('id', 'http://a.b.com/?id=a#/index/?id=b') => 'a'
 * ```
 */
export default function getUrlParam(name: string, url?: string): string | null;