diff options
Diffstat (limited to 'node_modules/base64-url/README.md')
| -rw-r--r-- | node_modules/base64-url/README.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/node_modules/base64-url/README.md b/node_modules/base64-url/README.md new file mode 100644 index 0000000..d9368c8 --- /dev/null +++ b/node_modules/base64-url/README.md @@ -0,0 +1,55 @@ +# base64-url + +Base64 encode, decode, escape and unescape for URL applications. + +<a href="https://nodei.co/npm/base64-url/"><img src="https://nodei.co/npm/base64-url.png?downloads=true"></a> + +[](https://travis-ci.org/joaquimserafim/base64-url) + + +## API + +```js +base64url.encode('Node.js is awesome.'); +// returns Tm9kZS5qcyBpcyBhd2Vzb21lLg + +base64url.decode('Tm9kZS5qcyBpcyBhd2Vzb21lLg'); +// returns Node.js is awesome. + +base64url.escape('This+is/goingto+escape=='); +// returns This-is_goingto-escape + +base64url.unescape('This-is_goingto-escape'); +// returns This+is/goingto+escape== +``` + + +## Development + +**this projet has been set up with a precommit that forces you to follow a code style, no jshint issues and 100% of code coverage before commit** + + +to run test +``` js +npm test +``` + +to run jshint +``` js +npm run jshint +``` + +to run code style +``` js +npm run code-style +``` + +to check code coverage +``` js +npm run check-coverage +``` + +to open the code coverage report +``` js +npm run coverage +``` |
