https://github.com/bifot/params-url

Serialize params from object to URL.
https://github.com/bifot/params-url

Last synced: 3 months ago
JSON representation

Serialize params from object to URL.

• Host: GitHub
• URL: https://github.com/bifot/params-url
• Owner: bifot
• License: mit
• Created: 2017-07-14T20:52:59.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-25T09:34:20.000Z (about 7 years ago)
• Last Synced: 2024-10-07T17:01:15.162Z (3 months ago)
• Language: JavaScript
• Size: 15.6 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
[![params-url](https://img.shields.io/npm/v/params-url.svg?style=flat-square)](https://www.npmjs.com/package/params-url/)

[![params-url](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)

# Params Url

Serialize params from object to URL.

## Install

```sh

$ npm i params-url -S

```

or use CDN:

```sh

```

## Tests

```sh

$ npm test

```

## Usage

```javascript

const urlParams = require('params-url')

```

## Methods

* [.add (url, params)](#add-url-params)

* [.delete (url, params)](#delete-url-params)

* [.generate (url, params)](#generate-url-params)

* [.parse (url)](#parse-url)

### .add (url, params)

| Parameter  | Type      | Requried  |

| -----------|:---------:| ---------:|

| url        | string    | yes       |

| params     | object    | yes       |

Returns a new url with new parameters.

```javascript

const url = urlParams.add('https://api.com?q=dogs', {

  act: 'find',

  type: [ 'good', 'beautiful' ],

  v: 2

})

console.log(url)

// => https://api.com?q=test&act=create&v=2

```

### .delete (url, params)

Returns a new url without the specified parameters.

| Parameter  | Type      | Requried  |

| -----------|:---------:| ---------:|

| url        | string    | yes       |

| params     | array     | yes       |

```javascript

const url = urlParams.delete('https://api.com?q=dogs&act=find&type=good&type=beautiful', [

  'q',

  'type'

])

console.log(url)

// => https://api.com?v=2

```

### .generate (url, params)

| Parameter  | Type      | Requried  |

| -----------|:---------:| ---------:|

| url        | string    | yes       |

| params     | object    | yes       |

Returns a url with parameters.

```javascript

const url = urlParams.generate('https://api.com/', {

  q: 'dogs',

  act: 'find',

  type: [ 'good', 'beautiful', 'husky' ],

  v: 2

})

console.log(url)

// => https://api.com?foo=bar&q=example%20with%20spaces&arr=1&arr=2&arr=3&v=2

```

### .parse (url)

| Parameter  | Type      | Requried  |

| -----------|:---------:| ---------:|

| url        | string    | yes       |

Returns object of parameters.

```javascript

const url = urlParams.parse('https://api.com?q=dogs&act=find&type=good&type=beautiful&type=husky&v=2')

console.log(url)

// {

//   q: 'dogs',

//   act: 'find',

//   type: [ 'good', 'beautiful', 'husky' ],

//   v: '2'

// }

```

## License

MIT.