@done-coding/url-base

URL 操作基础工具库

安装

npm install @done-coding/url-base
# 或
yarn add @done-coding/url-base
# 或
pnpm add @done-coding/url-base

使用方法

import { obj2SearchParams, PathSearchParams } from '@done-coding/url-base'

// 对象转 searchParams
const params = { name: 'test', age: 18 }
const searchParams = obj2SearchParams(params)
console.log(searchParams) // '?name=test&age=18'

// 使用 PathSearchParams 类处理路径和查询参数
const pathSearchParams = new PathSearchParams({
  '/users': {
    page: (value: string) => Number(value),
    size: (value: string) => Number(value),
    name: (value: string) => value
  }
})

const url = pathSearchParams.getUrl('/users', {
  page: 1,
  size: 10,
  name: 'test'
})
console.log(url) // '/users?page=1&size=10&name=test'

API

obj2SearchParams(obj: Record<string, any>)

将对象转换为 URL 查询参数字符串。

参数

• obj: 要转换的对象，值为 undefined 或 null 的键值对会被忽略

返回值

返回查询参数字符串，如果对象为空则返回空字符串，否则返回以 ? 开头的查询参数字符串。

PathSearchParams 类

用于处理路径和查询参数的类。

构造函数

constructor(paramsFnMap: Record<string, Record<string, (value: string) => any>>)

• paramsFnMap: 路径参数映射对象，key 为路径，value 为参数解析函数映射

方法

getUrl(path: string, searchParams: Record<string, any>)

获取完整的 URL（包含路径和查询参数）。

• path: 路径
• searchParams: 查询参数对象

返回完整的 URL 字符串。

开发

# 安装依赖
pnpm install

# 开发模式
pnpm dev

# 构建
pnpm build

# 运行测试
pnpm test

许可证

MIT