首页
/ Purl (JavaScript URL解析器) 技术文档

Purl (JavaScript URL解析器) 技术文档

2024-12-15 13:43:26作者:范垣楠Rhoda

Purl 是一个 AMD 兼容的 JavaScript 工具,用于解析 URL 并提供对其属性(如协议、主机、端口等)、路径段、查询字符串参数、片段参数等的轻松访问。

以下是关于如何安装和使用 Purl 的详细技术文档。

1. 安装指南

Purl 可以通过以下方式安装:

  • 通过 npm 安装:在命令行中运行以下命令来安装 Purl:

    npm install purl
    
  • 通过 CDN 链接:可以直接在 HTML 文件中通过 CDN 链接引入 Purl:

    <script src="https://cdn.jsdelivr.net/npm/purl/dist/purl.js"></script>
    
  • 下载源代码:可以从 Purl 的 GitHub 仓库下载最新版本的源代码。

2. 项目使用说明

Purl 可以在包含或不含 jQuery 的情况下使用。以下是两种使用方式的基本示例:

使用 jQuery

// 解析当前页面的 URL
var url = $.url();

// 解析指定的 URL
var url = $.url('http://allmarkedup.com');

// 从选择的元素中提取 URL 并解析
var url = $('#myElement').url();

不使用 jQuery

// 解析当前页面的 URL
var url = purl();

// 解析指定的 URL
var url = purl('http://allmarkedup.com');

3. 项目 API 使用文档

以下是 Purl API 的详细使用说明:

URL 属性

使用 .attr() 方法可以返回 URL 的各种属性信息。

var url = purl('http://allmarkedup.com/folder/dir/index.html?item=value');
url.attr('protocol'); // 返回 'http'
url.attr('path'); // 返回 '/folder/dir/index.html'

可查询的属性包括:

  • source: 被解析的完整 URL
  • protocol: 例如 http, https, file 等
  • host: 例如 www.mydomain.com, localhost 等
  • port: 例如 80
  • relative: 包括查询字符串的相对路径
  • path: 文件路径
  • directory: 路径的目录部分
  • file: 文件的基名
  • query: 如果存在,返回完整的查询字符串
  • fragmentanchor: # 符号后的整个字符串

查询字符串参数

使用 .param() 方法可以返回查询字符串参数的值。

purl('http://allmarkedup.com?sky=blue&grass=green').param('sky'); // 返回 'blue'

如果不传递参数,则返回所有查询字符串参数的键值对映射。

URL 路径段

使用 .segment() 方法可以返回 URL 路径中特定段的价值。

var url = purl('http://allmarkedup.com/folder/dir/example/index.html');
url.segment(1); // 返回 'folder'
url.segment(-2); // 返回 'example'

如果不传递参数,则返回所有路径段的数组。

片段参数和/或路径段

对于使用片段存储查询字符串样式的键值对或斜杠分隔路径的情况,可以使用 .fparam().fsegment() 方法。

purl('http://test.com/#sky=blue&grass=green').fparam('grass'); // 返回 'green'
purl('http://test.com/#/about/us/').fsegment(1); // 返回 'about'

严格模式和相对 URL

Purl 内部使用 Steven Levithan 的 Regex URI 解析器,具有宽松和严格两种模式。默认使用宽松模式,但宽松模式不会正确解析相对 URL。可以通过以下方式启用严格模式:

var url = purl(true); // 以严格模式解析当前页面的 URL

4. 项目安装方式

项目安装方式已在“安装指南”部分详细说明,此处不再赘述。

以上就是关于 Purl 的技术文档,希望对您的使用有所帮助。

热门项目推荐
相关项目推荐

项目优选

收起
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
46
37
PDFMathTranslatePDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/Docker
Python
30
3
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
171
39
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
165
34
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
249
63
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
24
17
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
892
0
RuoYi-CloudRuoYi-Cloud
🎉 基于Spring Boot、Spring Cloud & Alibaba的分布式微服务架构权限管理系统,同时提供了 Vue3 的版本
Java
25
10
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
391
102
杨帆测试平台杨帆测试平台
扬帆测试平台是一款高效、可靠的自动化测试平台,旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块,支持多种类型的测试用例,目前支持API(http和grpc协议)、性能、CI调用等功能,并且可定制化,灵活满足不同场景的需求。 其中,支持批量执行、并发执行等高级功能。通过用例设置,可以设置用例的基本信息、运行配置、环境变量等,灵活控制用例的执行。
JavaScript
11
2