build-url-ts

build-url-ts ( Typescript )

A library that builds a URL, including its path, query parameters and fragment identifier. Works in node and in the browser.

This is a fork from https://github.com/steverydz/build-url to add typescript support for the library

Installation

To install with npm:

npm install build-url-ts --save

Usage

import { buildUrl } from 'build-url-ts';

buildUrl('http://example.com', {
  path: 'about',
  hash: 'contact',
  queryParams: {
    foo: bar,
    bar: ['foo', 'bar']
  }
});

Options

The buildUrl function accepts two arguments. The first is a URL e.g. http://example.com. The second is an object where you can specify the path, hash, lowerCase, and an object of queryParams:

index('http://example.com', {
    path: 'about',
    hash: 'contact',
    queryParams: {
        foo: 'bar',
        bar: 'baz'
    }
});

// returns http://example.com/about?foo=bar&bar=baz#contact

If you pass an array to the queryParams object, it will be transformed to a comma separated list:

index('http://example.com', {
    queryParams: {
        foo: 'bar',
        bar: ['one', 'two', 'three']
    }
});

// returns http://example.com?foo=bar&bar=one,two,three

If you want to change the path, hash and queryParams case to all lowercase then pass lowerCase as true in arguments, default value of this will be false:

index('http://example.com', {
    path: 'AbouT',
    hash: 'ConTacT',
    lowerCase: true,
    queryParams: {
        foo: 'bAr',
        bar: ['oNe', 'TWO', 'thrEE', 123]
    }
});

// returns http://example.com/about?foo=bar&bar=one,two,three,123#contact

If you pass an array to the queryParams object, and want that they should not be comma separated use disableCSV:

index('http://example.com', {
    disableCSV: true,
    queryParams: {
        foo: 'bar',
        bar: ['one', 'two', 'three']
    }
});

// returns http://example.com?foo=bar&bar=one&bar=two&bar=three

if you need the array as an array in the query string, you can pass disableCSV as one of this values 'array' | 'order_asc' | 'order_desc':

index('http://example.com', {
    disableCSV: 'array',
    queryParams: {
        foo: 'bar',
        bar: ['one', 'two', 'three']
    }
});

// returns http://example.com?foo=bar&bar[]=one&bar[]=two&bar[]=three

If you only want the query string, path, hash, or any combination of the three you can skip the URL parameter or pass in an empty string or null:

index('', {
    queryParams: {
        foo: 'bar',
        bar: 'baz'
    }
});

// returns ?foo=bar&bar=baz

index(null, {
    queryParams: {
        foo: 'bar',
        bar: 'baz'
    }
});

// returns ?foo=bar&bar=baz

index({
    queryParams: {
        foo: 'bar',
        bar: 'baz'
    }
});

Any null values in the queryParams object will be treated as empty strings:

index('http://example.com', {
    queryParams: {
        foo: 'bar',
        bar: null
    }
});

// returns http://example.com?foo=bar&bar=

License

This is licensed under an MIT License. See details