@128keaton/url-assembler 中文文档教程

Question

node-url-assembler

从类路由模板 (/path/:param)

组装 urls从模板组装 URL 的实用程序

Installation

npm install --save url-assembler

Usage

Basic

UrlAssembler()
  .template('/users/:user')
  .param('user', 8)
  .param('include', 'address')
  .query({
    some: 'thing',
    other: 1234
  })
  .toString() // => "/users/8?include=address&some=thing&other=1234

With base URL

因为您经常需要一个主机名和一个协议来配合它

UrlAssembler('http://my.domain.com:9000')
  .template('/groups/:group/users/:user')
  .param({
    group: 'admin',
    user: 'floby'
  })
  .toString() // => "http://my.domain.9000/groups/admin/users/floby"

Incremental assembling

您也可以逐步构建您的 URL。

UrlAssembler('https://api.site.com/')
  .prefix('/v2')
  .segment('/users/:user')
  .segment('/projects/:project')
  .segment('/summary')
  .param({
    user: 'floby',
    project: 'node-url-assembler'
  })
  .toString() // => 'https://api.site.com/v2/users/floby/projects/node-url-assembler/summary'

making requests

如果 url-assembler 找到 request 模块。 然后是一个 .request 属性 在可用于发出请求的每个实例上都可用。

var google = UrlAssembler('https://google.com').query('q', 'url assembler');

google.request.get() // => makes a GET request to google

// you can still pass any other option to request
google.request.get({json: true})

Design

每个方法（toString() 除外）都会返回一个新的 UrlAssembler 实例。 你可以 考虑 UrlAssembler 实例是不可变的。

因此，您可以将单个实例用作预配置的 url，以便在整个代码库中重复使用。

var api = UrlAssembler('http://api.site.com');

var userResource = api.segment('/users/:user');

var userV1 = userResource.prefix('/v1');
var userV2 = userResource.prefix('/v2');

var userFeedResource = userV2.segment('/feed');

var authenticated = api.query('auth_token', '123457890');

var adminResource = authenticated.segment('/admin');

此外，UrlAssembler 的实例是要传递的有效对象 url.format() 或任何接受此类对象的函数 范围。

API Reference

new UrlAssembler([baseUrl])

• baseUrl: will be used for protocol, hostname, port and other base url kind of stuff.
• returns an instance of a URL assembler.

new UrlAssembler(urlAssembler)

• urlAssembler: an existing instance of UrlAssembler
• this constructor is used for chaining internally. You should be aware of it if you extend UrlAssembler
• returns a new instance of a URL assembler, copying the previous one

.template(template)

• template a string with dynamic part noted as :myparam . For example '/hello/:param/world'
• returns a new instance of UrlAssembler with this template configured

.prefix(subPath)

• subPath : this string will be added at the beginning of the path part of the URL
• if called several times, the subPath will be added after the previous prefix but before the rest of the path
• returns a new instance of UrlAssembler

.segment(subPathTemplate)

• subPathTemplate is a string of a segment to add to the path of the URL. It can have a templatized parameter eg. '/user/:user'
• if called several times, the segment will be added at the end of the URL.
• returns a new instance of UrlAssembler

.param(key, value[, strict])

• key: a string of the dynamic part to replace
• value: a string to replace the dynamic part with
• returns a new instance of UrlAssembler with the parameter key replaced with value. If strict is falsy, the key will be added as query parameter.

.param(params[, strict])

• params: a hash of key/value to give to the method above
• strict a flag passed to the method above
• returns a new instance of UrlAssembler with all the parameters from the params replaced

.query(key, value)

• key: the name of the parameter to configure
• value: the value of the parameter to configure
• returns a new instance of UrlAssembler with the key=value pair added as query parameter with the qs module.

.query(params)

• shortcut for the previous method with a hash of key/value.

.toString(), .valueOf(), toJSON()

• returns a string of the current state of the UrlAssembler instance. Path parameters not yet replaced will appear as :param_name.

Test

测试使用 mocha 编写并使用 istanbul< /a> 您可以使用 npm test 运行测试。

Contributing

欢迎任何人提交问题和拉取请求

License

MIT

版权所有 (c) 2015 Florent Jaby

特此免费授予任何人许可获得本软件和相关文档文件（“软件”）副本的人，可以不受限制地处理本软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售的权利软件的副本，并允许获得软件的人这样做，但须满足以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或重要部分中。

本软件“按原样”提供，不提供任何明示或暗示的保证，包括但不限于对适销性、特定用途的适用性和非侵权的保证。 在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权行为还是其他方面，由软件或软件的使用或其他交易引起、由软件引起或与之相关软件。