1 | # base64-url
|
2 |
|
3 | Base64 encode, decode, escape and unescape for URL applications.
|
4 |
|
5 | <a href="https://nodei.co/npm/base64-url/"><img src="https://nodei.co/npm/base64-url.png?downloads=true"></a>
|
6 |
|
7 |
|
8 | [![Build Status](https://travis-ci.org/joaquimserafim/base64-url.svg?branch=master)](https://travis-ci.org/joaquimserafim/base64-url)[![Coverage Status](https://coveralls.io/repos/github/joaquimserafim/base64-url/badge.svg)](https://coveralls.io/github/joaquimserafim/base64-url)[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg?style=flat-square)](https://github.com/joaquimserafim/base64-url/blob/master/LICENSE)[![NodeJS](https://img.shields.io/badge/node-6.x.x-brightgreen.svg?style=flat-square)](https://github.com/joaquimserafim/base64-url/blob/master/package.json#L43)
|
9 |
|
10 | [![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
|
11 |
|
12 |
|
13 | ## API
|
14 |
|
15 | `const base64url = require('base64-url')`
|
16 |
|
17 |
|
18 | ### examples
|
19 |
|
20 | ```js
|
21 |
|
22 | base64url.encode('Node.js is awesome.')
|
23 | // returns Tm9kZS5qcyBpcyBhd2Vzb21lLg
|
24 |
|
25 | base64url.decode('Tm9kZS5qcyBpcyBhd2Vzb21lLg')
|
26 | // returns Node.js is awesome.
|
27 |
|
28 | base64url.escape('This+is/goingto+escape==')
|
29 | // returns This-is_goingto-escape
|
30 |
|
31 | base64url.unescape('This-is_goingto-escape')
|
32 | // returns This+is/goingto+escape==
|
33 |
|
34 | //
|
35 | // setting a different encoding
|
36 | //
|
37 |
|
38 | base64url.encode(string to encode, encoding)
|
39 | base64url.decode(string to decode, encoding)
|
40 |
|
41 | ```
|
42 |
|
43 |
|
44 | #### ISC License (ISC)
|
45 |
|
46 | # Alternatives
|
47 |
|
48 | - [base64url](https://github.com/brianloveswords/base64url)
|