-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
193 additions
and
161 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,8 @@ | ||
| #!/bin/sh | ||
| #!/bin/bash | ||
|
|
||
| yarn clean | ||
| ./node_modules/.bin/jest --coverage --runInBand | ||
| set -e | ||
|
|
||
| PROJECT_DIR=$(git rev-parse --show-toplevel) | ||
|
|
||
| $PROJECT_DIR/scripts/clean.sh | ||
| $PROJECT_DIR/scripts/test.sh --coverage "$@" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,7 @@ | ||
| #!/bin/sh | ||
| #!/bin/bash | ||
|
|
||
| ./node_modules/.bin/eslint src | ||
| set -e | ||
|
|
||
| PROJECT_DIR=$(git rev-parse --show-toplevel) | ||
|
|
||
| $PROJECT_DIR/node_modules/.bin/eslint $PROJECT_DIR/src "$@" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,8 @@ | ||
| #!/bin/sh | ||
| #!/bin/bash | ||
|
|
||
| yarn clean | ||
| ./node_modules/.bin/jest --runInBand | ||
| set -e | ||
|
|
||
| PROJECT_DIR=$(git rev-parse --show-toplevel) | ||
|
|
||
| $PROJECT_DIR/scripts/clean.sh | ||
| $PROJECT_DIR/node_modules/.bin/jest --runInBand "$@" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # @zakkudo/query-string | ||
|
|
||
| Make working with url query-strings enjoyable. | ||
|
|
||
| [](https://travis-ci.org/zakkudo/query-string) | ||
| [](https://coveralls.io/github/zakkudo/query-string?branch=master) | ||
| [](https://snyk.io/test/github/zakkudo/query-string) | ||
|
|
||
| ## Why use this? | ||
|
|
||
| - Consistancy with simplicity | ||
| - The instance acts like a plain-old-object | ||
| - `JSON.stringify()` will serialize it to json like it was a normal object | ||
| - Casting to a string will format it to be directly usable in a query | ||
| Update the properties after initialization and the serialization will reflect the updates | ||
| - Complex params are automatically serialized and deserialized from json | ||
|
|
||
| ## Install | ||
|
|
||
| ```console | ||
| # Install using npm | ||
| npm install @zakkudo/query-string | ||
| ``` | ||
|
|
||
| ``` console | ||
| # Install using yarn | ||
| yarn add @zakkudo/query-string | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Initializing with an object | ||
| ```javascript | ||
| import QueryString from '@zakkudo/query-string'; | ||
|
|
||
| const query = new QueryString({ | ||
| page: 3, | ||
| title: 'awesomeness', | ||
| complex: {'test': 'value'} | ||
| }); | ||
|
|
||
| String(query) // '?page=3&title=awesomeness&complex=%7B%22test%22%3A%22value%22%7D&' | ||
| query.toString() // '?page=3&title=awesomeness&complex=%7B%22test%22%3A%22value%22%7D&' | ||
|
|
||
| const url = `http://example${query}` //Automatically serializes correctly | ||
|
|
||
| const url = `http://example${query}` //Automatically serializes correctly with changes | ||
| ``` | ||
|
|
||
| ### Initializing with a URL and making changes dynamically | ||
| ```javascript | ||
| import QueryString from '@zakkudo/query-string'; | ||
|
|
||
| const query = new QueryString('http://example?page=3&title=awesomeness'); | ||
|
|
||
| delete query.page; | ||
|
|
||
| String(query) // '?title=awesomeness' | ||
| query.toString() // '?title=awesomeness' | ||
| ``` | ||
|
|
||
| ### Error handling | ||
| ```javascript | ||
| import QueryString from '@zakkudo/query-string'; | ||
| import QueryStringError from '@zakkudo/query-string/QueryStringError'; | ||
|
|
||
| try { | ||
| const query = new QueryString('http://invalid.com/?first=1?second=2') | ||
| } catch(e) { | ||
| if (e instanceof QueryStringError) { | ||
| console.error(e.message); // Trying to add duplicate query param when already exists | ||
| } else { | ||
| throw e; | ||
| } | ||
| } | ||
| ``` | ||
|
|
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.