# ke-url.js

**Repository Path**: janpoem/ke-url.js

## Basic Information

- **Project Name**: ke-url.js
- **Description**: 一个URL处理的工具类库，支持浏览器环境（IE兼容IE9.0）或node.js环境使用。
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 10
- **Forks**: 0
- **Created**: 2016-11-13
- **Last Updated**: 2022-07-11

## Categories & Tags

**Categories**: javascript-toolkits

**Tags**: None

## README

# ke-url.js

一个URL处理的工具类库，支持浏览器环境（IE兼容IE9.0）或node.js环境使用。

这个类库包含了主要的的URL的处理方法：

1. 请求字符串（Query String）的处理，包括encode、decode、解析和构造请求字符串。
2. URL的路径处理方法。
3. URL的解析和构建，UserInfo的解析和Host的解析。
4. 一个URL的类 `keUrl` ，以便于更便捷的对URL实例进行处理。

详细文档请查看[Wiki](http://git.oschina.net/janpoem/ke-url.js/wikis/home)。

## 浏览器前端使用

引入ke-url.js的打包文件。

```html
<script type="text/javascript" src="ke-url.min.js"></script>
```

然后可以直接访问全局变量 `keUrl` 。

```javascript
// 创建一个URL实例
var url = new keUrl('http://www.oschina.net/');
url.mergeQuery('hello=world');
console.log(url.toUrl());

// 解析字符串
keUrl.parseQuery('?hello=world&id=1');
// 解析URL，返回一个对象，而不是一个keUrl实例
keUrl.parseUrl('http://git.oschina.net/');
// URL编码
keUrl.encode('ok!');
```

## requirejs中使用（AMD）

```javascript
// 引入ke-url
define(['ke-url'], function(keUrl) {
    var url = new keUrl('http://www.oschina.net/');
    console.log(url.toUrl());
});
```

## node.js中使用

```
npm install ke-url --save-dev
```

```javascript
const keUrl = require('ke-url');
var url = new keUrl('http://www.oschina.net/');
console.log(url.toUrl());
```