Skip to content

Commit 63c15f4

Browse files
committed
docs(kitsu-core): add example for query
1 parent 5a805ee commit 63c15f4

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

packages/kitsu-core/src/query/index.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,18 @@ function queryFormat (value, key) {
1717
* @param {Object} params Parameters to parse
1818
* @param {string} prefix Prefix for nested parameters - used internally (default `null`)
1919
* @returns {string} URL query string
20+
*
21+
* @example
22+
* query({
23+
* filter: {
24+
* slug: 'cowboy-bebop',
25+
* title: {
26+
* value: 'foo'
27+
* }
28+
* }
29+
* sort: '-id'
30+
* })
31+
* // filter%5Bslug%5D=cowboy-bebop&filter%5Btitle%5D%5Bvalue%5D=foo&sort=-id
2032
*/
2133
export function query (params, prefix = null) {
2234
const str = []

0 commit comments

Comments
 (0)