http-url-builder v1.1.0

UrlBuilder

branch	build	coverage
main
develop

Utility to help building http urls for your API.

Installing

$ npm install http-url-builder

Examples

Basic setup:

import { UrlBuilder } from 'http-url-builder';

const url = UrlBuilder.create('localhost', 8080).build();

console.log(url);
// https://localhost:8080

Build an url:

// 'false' uses 'http' instead of 'https'
const url = UrlBuilder.create('localhost', 8080/*, false*/)
    .addPath('foo')
    .addPath('bar')
    .addQueryParam('baz', 'qux')
    .addQueryParam('test', 123)
    .build();

console.log(url);
// https://localhost:8080/foo/bar?baz=qux&test=123

addQueryParam() accepts strings, numbers, booleans and objects. Objects will be converted to their JSON representation to create the url.

const obj = {
    foo: 'bar',
    baz: 0,
    qux: true,
};
const url = UrlBuilder.create('localhost', 8080)
    .addPath('example')
    .addQueryParam('myObj', obj)
    .build();

console.log(url);
// https://localhost:8080/example?myObj={"foo":"bar","baz":0,"qux":true}

Each addPath() and addQueryParam() operation creates a new UrlBuilder instance. Thanks to immutability, paths can not be accidentally modified:

const base = UrlBuilder.create('localhost', 8080).addPath('base');

const fooUrl = base.addPath('foo');
const barUrl = base.addPath('bar');

console.log(base.build());   // https://localhost:8080/base
console.log(fooUrl.build()); // https://localhost:8080/base/foo
console.log(barUrl.build()); // https://localhost:8080/base/bar

If you already have an url, you can convert it to an UrlBuilder instance by using its constructor:

const url = new UrlBuilder("https://localhost:8080/my/path");

License

MIT