url-safe-base64
Version:
url safe base64 en- and decoding
112 lines (73 loc) • 2.12 kB
Markdown
# url-safe-base64
> url safe base64 en- and decoding
[](https://www.npmjs.com/package/url-safe-base64/)
## TOC
* [Example](#example)
* [API](#api)
* [`encode(base64)`](#encodebase64)
* [`decode(safe)`](#decodesafe)
* [`trim(string)`](#trimstr)
* [`isBase64(string)`](#isbase64string)
* [`isUrlSafeBase64(string)`](#isurlsafebase64string)
* [Installation](#installation)
* [Tests](#tests)
* [LICENSE](#license)
## Example
```js
import {
encode, decode, trim,
isBase64, isUrlSafeBase64
} from 'url-safe-base64'
const safe = encode('A/B+C==')
// > 'A-B_C=='
trim(safe)
// > 'A-B_C'
const base64 = decode(safe)
// > 'A/B+C=='
isBase64(base64)
// > true
isBase64(safe)
// > false
isUrlSafeBase64(base64)
// > false
isUrlSafeBase64(safe)
// > true
```
## API
### `encode(base64)`
encode base64 string url safe
**Parameters**
| parameter | type | description |
| --------- | ------ | ----------------------- |
| `base64` | String | base64 encoded string |
**Returns** `String`, url-safe-base64 encoded
### `decode(safe)`
decode url-safe-base64 string to base64
**Parameters**
| parameter | type | description |
| --------- | ------ | ------------------------ |
| `safe` | String | - url-safe-base64 string |
**Returns** `String`, base64 encoded
### `trim(string)`
trim padding - `window.atob` might handle trimmed strings, e.g. in Chrome@57, Firefox@52
**Parameters**
| parameter | type | description |
| --------- | ------ | ---------------------------------- |
| `string` | String | - base64 or url-safe-base64 string |
**Returns** `String`, string with padding chars removed
### `isBase64(string)`
checks if `string` is base64 encoded
**Returns** `Boolean`, true if base64 encoded
### `isUrlSafeBase64(string)`
checks if `string` is url-safe-base64 encoded
**Returns** `Boolean`, true if url-safe-base64 encoded
## Installation
```sh
$ npm install --save url-safe-base64
```
## Tests
```sh
$ npm test
```
## LICENSE
UNLICENSE <https://unlicense.org/>