simple-url-stringify
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

simple-url-stringify

install

npm i simple-url-stringify

usage

query

import { urlStringify } from 'simple-url-stringify';

urlStringify({
  url: '/a/b/c',
  query: {
    a: 1,
    b: 2 
  } 
})
// '/a/b/c?a=1&b=2'

urlStringify({
  url: '/a/b/c',
  query: {
    a: undefined,
    b: 2 
  } 
})
// '/a/b/c?b=2'

urlStringify({
  url: '/a/b/c',
  query: {
    a: undefined,
    b: undefined 
  } 
})
// '/a/b/c'

urlStringify({
  url: '/a/b/c',
  query: {
    a: {
      b: 1,
      c: 2
    }
  } 
})
// '/a/b/c?a.b=1&a.c=2'

urlStringify({
  url: '/a/b/c',
  query: {
    a: {
      b: 1,
      c: 2
    }
  } 
}, { allowDots: false })
// '/a/b/c?a%5Bb%5D=1&a%5Bc%5D=2'
// `/a/b/c?${encodeURI('a[b]=1&a[c]=2')}`

params

import { urlStringify } from 'simple-url-stringify';
urlStringify({
  url: '/a/b/{a}/{b}',
  params: {
    a: 1,
    b: 2 
  } 
})
// '/a/b/1/2'

urlStringify({
  url: '/a/b/[a]/[b]',
  params: {
    a: 1,
    b: 2 
  } 
}, {
  paramsTemplatePrefix: '\\[',
  paramsTemplateSuffix: '\\]'
})
// '/a/b/1/2'

Readme

Keywords

Package Sidebar

Install

npm i simple-url-stringify

Weekly Downloads

0

Version

1.0.3

License

MIT

Unpacked Size

1.95 MB

Total Files

30

Last publish

Collaborators

  • lvliqi