URL path params/query resolve with ease
This is a helper librarly that combine the use of path-to-regexp with qs query string library. While those librarly work independently, the former is for generating path with path params, the latter is for generating query string from object (or in the reverse). This library combinses the use of these two path to build url.
The library is written in ES6 most advance syntax.
Please enjoy!
$ npm install --save @rentspree/path
or if you are a fan of Yarn
$ yarn add @rentspree/path
import { buildPath } from "@rentspree/path";
// return "/api/user/1234?name=John&lastName=Doe"
buildPath("/api/user/:id", {id: "1234"}, {name: "John", lastName: "Doe"})
Or if you are interested in only using the query string append, you can surely do it
import { query } from "@rentspree/path"
// return "?name=John&lastName=Doe"
query.stringify({name: "John", lastName: "Doe"})
// returns {query: "hello", consulta: "hola"}
query.parse("?query=hello&consulta=hola")
Default error class
Build path from path regexp and params and optionally append query suffix to the path
path
String the path regexparams
Object the params to interpolate in pathquery
Object? the query object to be converted to string
// return /api/user/123456?name=John&lastName=Doe
buildPath("/api/user/:id", {id: "123456"}, {name: "John", lastName: "Doe"}
// return /content/post/this-is-a-good-post
buildPath("/content/post/:slug", {slug: "this-is-a-good-post"})
Returns (String | null) the built path
Set the Error class which would be thrown when buildPath function failed
error
Class an Error class which would be thrown
// if you set
setErrorClass(SomeClass)
// when the buildPath function failed it will throw something like this
throw new SomeClass()
Join all arguments together and normalize the resulting url. This function using url-join library
// returns "/content/post/foo"
urlJoin("/content/post/", "/foo")
// returns "/content/post?foo=bar"
urlJoin("/content/post/", "?foo=bar")
This method parse a query string into object
str
String the string to parse (optional, default""
)
// returns {str1: "hello", str2: "hola"}
parse("?str1=hello&str2=hola")
// returns {name: "John", lastName: "Doe"}
parse("name=John&lastName=Doe")
Returns Object the query object parsed from query string
This method stringify object into query string
obj
Object the object to be stringify (optional, default{}
)
// returns "?name=John&lastName=Doe"
stringify({name: "John", lastName: "Doe"})
Returns String the stringified query result
This method get subdomain from the url
getSubdomain(url, subdomains, defaultSub)
url
: The url that you want to get subdomain fromsubdomains
: The list of subdomains that you allow to get (default:{}
)defaultSub
: The default return of subdomain (default:rentspree
)
Returns String the string of subdomain
// return "apple"
getSubdomain("https://apple.rentspree.com")
// return "boy"
getSubdomain("boy.rentspree.com", {apple: "apple", boy: "boy"})
// return "rentspree"
getSubdomain("cat.rentspree.com", {apple: "apple"})
// return "www"
getSubdomain("dog.rentspree.com", {apple: "apple"}, "www")
This method create url from provided subdomain, host, and path
parseSubdomain(subdomain, host, path)
Returns String full url with subdomain
// return "https://foo.rentspree.com/dashboard"
parseSubdomain("foo", "https://www.rentspree.com", "/dashboard")
// return "https://www.rentspree.com/a/b/c
parseSubdomain("rentspree", "https://www.rentspree.com", "a", "/b", "c")
MIT © Potsawee Vechpanich