godaddy / transform-url

Build URLs by transforming a template with params.

TransformURL

Build URLs by transforming a template with params.

Installation

yarn add transform-url

or

npm install --save transform-url

Usage

Query params

The first argument to transformUrl is a URL template, with the second being a params object of key/value pairs.

const transformUrl = require('transform-url');
const params = {
  userId: 'user-1234',
  orderId: 'order-6789'
};

const url = transformUrl('https://example.com', params);
// https://example.com?orderId=order-6789&userId=user-1234

Path params

If you want some params to be applied as path params, add placeholders to the URL template.

const url = transformUrl('https://example.com/api/users/:userId/orders/:orderId', params);
// https://example.com/api/users/user-1234/orders/order-6789

Mixed params

Any remaining params not specified in the URL template, will be applied as query params.

const url = transformUrl('https://example.com/api/users/:userId', params);
// https://example.com/api/users/user-1234?orderId=order-6789

Other params

Besides path and query params, placeholders can be added to any other part of the URL template.

const moreParams = {
  ...params,
  scheme: 'https',
  domain: 'example.com',
  hash: 'somePlace'
};

const url = transformUrl('{scheme}://{domain}/api/users/:userId#{hash}', moreParams);
// https://example.com/api/users/user-1234?orderId=order-6789#somePlace

Matchers

URL template placeholders can use either :colon or {curlyBraces} matchers. Additionally, it is possible to provide a custom matcher via options.

const options = {
  matcher: /\$(\w+)/g   // match `$paramName`
};

const url = transformUrl('$scheme://$domain/api/users/$userId#$hash', moreParams, options);
// https://example.com/api/users/user-1234?orderId=order-6789#somePlace

For additional options, see the API Reference below.

API Reference

transformUrl(urlTemplate, params, [options]) ⇒ String

Transform URL templates with provided params. Params that are not placeholders in the url template will be append as query params. Urls with a port number will be respected, for example http://example.com:8080

Kind: global function
Returns: String - transformed url

Param	Type	Description
urlTemplate	String	URL template to be transformed with params. URL template placeholders can use either :colon or {curlyBraces} matchers.
params	Object	Key/value pairs to be applied as path and/or query params. Required to include params for all placeholders.
[options]	Object	Optional configuration to output results.
[options.matcher]	RegExp	Specify regular expression for custom placeholders in URL templates.

transform-url's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency eslint-config-godaddy to v7
• chore(deps): update dependency jsdoc-to-markdown to v8

Detected dependencies

github-actions

.github/workflows/ci.yml

• actions/checkout v3
• actions/setup-node v3

npm

package.json

• @babel/cli ^7.18.10
• @babel/core ^7.18.13
• @babel/preset-env ^7.18.10
• babel-jest ^29.0.3
• coveralls ^3.1.1
• eslint ^8.22.0
• eslint-config-godaddy ^6.1.0
• eslint-plugin-jest ^27.0.0
• eslint-plugin-json ^3.1.0
• eslint-plugin-mocha ^10.1.0
• jest ^29.0.3
• jsdoc-to-markdown ^7.1.1

---

• Check this box to trigger a request for Renovate to run again on this repository