Js-url-helper NPM

introduce

介绍

Js-url-helper 是一个浏览器 URL 辅助工具。通过 Js-url-helper 可以很方便的操作 location 对象，获取，设置页面跳转参数。

如：

获取/设置 search 参数
获取/设置 hash 参数
执行 URL 跳转
生成 URL 链接

API 说明文档

download

下载

（仅下载至本地后使用，不能直接作为 CDN 资源引用）

未压缩unzipped

压缩(~zipped)

install

安装

npm

通过 npm

npm install --save js-url-helper

browser

浏览器环境：

<script src="js-url-helper.js"></script>

api

UrlHelper

实例化

new UrlHelper(location)

Arguments

location {Object} 浏览器 location 对象

Returns

{Object} UrlHelper 实例

Example

var urlHelper = new UrlHelper(location);

getSearchParam

getSearchParam(location)

获取 search 参数

Arguments

location 可选参数 {Object} 浏览器 location 对象

Returns

{Object} search 参数对象

Example

'http://www.example.com/path/index.html?query1=test&silly=willy'

var searchParam = urlHelper.getSearchParam();
// {query1: 'test', silly: 'willy'}

getHashParam

getHashParam(location)

获取 hash 参数

Arguments

location 可选参数 {Object} 浏览器 location 对象

Returns

{Object} hash 参数对象

Example

'http://www.example.com/path/index.html#test=hash&chucky=cheese'

var hashParam = urlHelper.getHashParam();
// {test: 'hash', chucky: 'cheese'}

setSearchParam

setSearchParam(param)

设置 search 参数

Arguments

param {Object} search 对象

Returns

{String} 带 search 信息的 URL 参数字符串

Example

var searchParamString = urlHelper.setSearchParam({
  query1: 'test1',
  silly: 'willy'
});
// '?query1=test1&silly=willy'

setHashParam

setHashParam(param)

设置 hash 参数

Arguments

param {Object} hash 对象

Returns

{String} 带 hash 信息的 URL 参数字符串

Example

var hashParamString = urlHelper.setHashParam({
  test: 'hash',
  chucky: 'cheese'
});
// '#test=hash&chucky=cheese'

link

link(param)

生成 URL 链接，参数为空为当前页。

Arguments

param {Object}
param.path {String} 跳转路径
param.search {String} search参数
param.hash {String} hash参数

Returns

{String} 链接地址

Example

var link = urlHelper.link({
  path: '/path/other',
  search: urlHelper.setSearchParam({
    chapterId: 1
  }),
  hash: urlHelper.setHashParam({
    questionId: 2
  })
});

或

var link = urlHelper.link({
  path: '/path/other',
  search: {
    chapterId: 1
  },
  hash: {
    questionId: 2
  }
});

document.getElementById('nextQuestion').href = link;

jump

jump(param)

执行 URL 跳转，参数为空则刷新当前页。

Arguments

param {Object}
param.path {String} 跳转路径
param.search {String} search参数
param.hash {String} hash参数

Returns

Example

urlHelper.jump({
  path: '/path/other',
  search: urlHelper.setSearchParam({
    chapterId: 1
  }),
  hash: urlHelper.setHashParam({
    questionId: 2
  })
});

或

urlHelper.jump({
  path: '/path/other',
  search: {
    chapterId: 1
  },
  hash: {
    questionId: 2
  }
});