1
0
mirror of https://github.com/bigchaindb/js-bigchaindb-driver.git synced 2024-11-29 07:16:25 +01:00
js-bigchaindb-driver/src/stringify_as_query_param.js

44 lines
1.4 KiB
JavaScript
Raw Normal View History

2017-06-12 16:57:29 +02:00
import coreObjectEntries from 'core-js/library/fn/object/entries'
import decamelize from 'decamelize'
import queryString from 'query-string'
2017-04-26 15:58:19 +02:00
/**
* @private
2017-04-26 15:58:19 +02:00
* imported from https://github.com/bigchaindb/js-utility-belt/
*
* Takes a key-value dictionary (ie. object) and converts it to a query-parameter string that you
* can directly append into a URL.
*
* Extends queryString.stringify by allowing you to specify a `transform` function that will be
* invoked on each of the dictionary's keys before being stringified into the query-parameter
* string.
*
* By default `transform` is `decamelize`, so a dictionary of the form:
*
* {
* page: 1,
* pageSize: 10
* }
*
* will be converted to a string like:
*
* ?page=1&page_size=10
*
* @param {Object} obj Query params dictionary
2017-04-26 15:58:19 +02:00
* @param {function} [transform=decamelize] Transform function for each of the param keys
* @return {string} Query param string
*/
export default function stringifyAsQueryParam(obj, transform = decamelize) {
if (!obj || typeof obj !== 'object' || !Object.keys(obj).length) {
2017-06-12 16:57:29 +02:00
return ''
2017-04-26 15:58:19 +02:00
}
const transformedKeysObj = coreObjectEntries(obj).reduce((paramsObj, [key, value]) => {
2017-06-12 16:57:29 +02:00
paramsObj[transform(key)] = value
return paramsObj
}, {})
2017-04-26 15:58:19 +02:00
2017-06-12 16:57:29 +02:00
return `?${queryString.stringify(transformedKeysObj)}`
}