URL 处理工具

功能描述

这是一个 TypeScript 工具，用于解析 URL 信息。

安装

npm install dy-url-kit

示例代码

import { parseURL, parseURLProtocol } from 'dy-url-kit'

// 一、 parseURL
// 1. parseURL("https://github.com/Xdy1579883916/dy-url-kit#readme")
// 2. parseURL("//github.com/Xdy1579883916/dy-url-kit#readme")
// 3. parseURL("/Xdy1579883916/dy-url-kit#readme", "https://github.com/")

// console: 

// {
//   "href": "https://github.com/Xdy1579883916/dy-url-kit#readme",
//   "url": "https://github.com/Xdy1579883916/dy-url-kit",
//   "origin": "https://github.com",
//   "protocol": "https:",
//   "host": "github.com",
//   "port": "",
//   "pathname": "/Xdy1579883916/dy-url-kit",
//   "search": "",
//   "hash": "readme",
//   "params": {},
//   "file": "dy-url-kit",
//   "domain": "github.com"
// }


// 二、 parseURLProtocol

// 1. parseURLProtocol("//github.com/Xdy1579883916/dy-url-kit#readme", "http:")
// 2. parseURLProtocol("github.com/Xdy1579883916/dy-url-kit#readme", "http:")

// console: 

// 'http://github.com/Xdy1579883916/dy-url-kit#readme'

// 3. https default 
// parseURLProtocol("github.com/Xdy1579883916/dy-url-kit#readme")

// console: 
// 'https://github.com/Xdy1579883916/dy-url-kit#readme'

函数列表

parseURLProtocol

将 URL 转换为带有协议的完整 URL。

参数：

• url (string): 需要解析的 URL 字符串。
• protocol (string, 默认值 'https:'): 如果 URL 不包含协议，则添加此协议。

返回值：

• 返回带有正确协议的 URL 字符串。

TParsesURLRes

定义了解析 URL 后返回的对象结构。

属性：

• href: 完整的 URL。
• url: 格式化后的 URL。
• origin: URL 的起源，包括协议和主机名。
• protocol: URL 的协议部分。
• host: URL 的主机名。
• port: URL 的端口号。
• pathname: URL 的路径。
• search: URL 的查询字符串。
• hash: URL 的哈希部分。
• params: 查询字符串解析后的参数对象。
• file: URL 路径中的文件名。
• domain: URL 的顶级域名。

parseURL

解析 URL 并返回详细的 URL 组件。

参数：

• url (string): 需要解析的 URL 字符串。
• baseOrigin (string | URL, 可选): 基础 URL，用于解析相对 URL。

返回值：

• 返回一个 TParsesURLRes 类型的对象，包含 URL 的各个组件。

License

MIT License © 2024-PRESENT XiaDeYu