Skip to content

Latest commit

 

History

History
66 lines (51 loc) · 1.54 KB

README.md

File metadata and controls

66 lines (51 loc) · 1.54 KB

Burly
Coverage Travis npm version

A simple Typescript URL builder

Installation


npm i --save kb-burly

Usage

Edit burly-examples-t6lzw

Basic:

const burly = Burly("https://api.com/find")
              .addParam("id", 1234)
              .get; // = https://api.com/find?id=1234

Nested query:

const object = {
  yes: 'no',
  maybe: '/test/',
  bad: null
}

const burly = Burly('http://test.com')
              .addQuery('where', object)
              .get; // = http://test.com?where=yes%3D%27no%27%26maybe%3D%27%2Ftest%2F%27

Null parameter:

const burly = Burly("http://bad-param.blog")
              .addParam('bad', null)
              .get; // = http://bad-param.blog

Reference:

new Burly([baseURL])

Credits

Based heavily on url-assembler by Florent Jaby