Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacobwgillespie/b64u
⚡Tiny, lightweight module for encoding and decoding Base64 URLs
https://github.com/jacobwgillespie/b64u
Last synced: about 2 months ago
JSON representation
⚡Tiny, lightweight module for encoding and decoding Base64 URLs
- Host: GitHub
- URL: https://github.com/jacobwgillespie/b64u
- Owner: jacobwgillespie
- License: mit
- Created: 2018-04-30T02:03:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-05T10:14:22.000Z (4 months ago)
- Last Synced: 2024-10-12T16:15:15.724Z (2 months ago)
- Language: JavaScript
- Size: 332 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚡ b64u
[](https://travis-ci.org/jacobwgillespie/b64u)
[](https://www.npmjs.com/package/b64u)
[](https://www.npmjs.com/package/b64u)
[](https://github.com/jacobwgillespie/b64u/blob/master/LICENSE)
[](https://www.typescriptlang.org/)
A tiny, lightweight module for encoding and decoding Base64 URLs ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)). Supports TypeScript, but also works without it.
**NOTE:** if you were previously using the unmaintained `base64url` package, this library is API-identical.
## Requirements
- NodeJS 8+
## Installation
Install via yarn:
```
yarn add b64u
```
Or via NPM:
```
npm install --save b64u
```
## Example
```typescript
import b64u from 'b64u'
b64u('A tiny, lightweight module')
// 'QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU'
b64u.encode('A tiny, lightweight module')
// 'QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU'
b64u.decode('Zm9yIGVuY29kaW5nIGFuZCBkZWNvZGluZyBCYXNlNjQgVVJMcw')
// 'for encoding and decoding Base64 URLs'
b64u.toBase64('QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU')
// 'QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU='
b64u.fromBase64('QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU=')
// 'QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU'
b64u.toBuffer(b64u('tiny'))
//
```
## Usage
Either require or import the library:
```javascript
const b64u = require('b64u')
```
```typescript
import b64u from 'b64u'
```
### API
#### b64u(input: string | Buffer, encoding = 'utf8'): string
#### b64u.encode(input: string | Buffer, encoding = 'utf8'): string
Encodes an `input` string or buffer into a Base64 URL. Optionally specify an `encoding`.
**Example**
```typescript
b64u('A tiny, lightweight module')
// 'QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU'
b64u.encode('A tiny, lightweight module')
// 'QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU'
```
#### b64u.decode(input: string | Buffer, encoding = 'utf8'): string
Decodes an `input` Base64 URL into a raw string. Optionally specify an `encoding`.
**Example**
```typescript
b64u.decode('Zm9yIGVuY29kaW5nIGFuZCBkZWNvZGluZyBCYXNlNjQgVVJMcw')
// 'for encoding and decoding Base64 URLs'
```
#### b64u.toBase64(input: string): string
Converts an `input` Base64 URL into a plain Base64 string.
**Example**
```typescript
b64u.toBase64('QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU')
// 'QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU='
```
#### b64u.fromBase64(input: string): string
Converts an `input` plain Base64 string into a Base64 URL.
**Example**
```typescript
b64u.fromBase64('QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU=')
// 'QSB0aW55LCBsaWdodHdlaWdodCBtb2R1bGU'
```
#### b64u.toBuffer(input: string): Buffer
Converts an `input` Base64 URL into a Buffer with the raw bytes.
**Example**
```typescript
b64u.toBuffer(b64u('tiny'))
//
```
## Background
This library began as an API-identical fork of the [`base64url` package](https://github.com/brianloveswords/base64url), as that package has not been updated since 2016 and currently suffers from [a critical issue](https://github.com/brianloveswords/base64url/issues/13) that prevents its use with TypeScript and any version of NodeJS other than Node 6.0.0.
Why the name, `b64u`? It's a tiny, lightweight name for a tiny, lightweight module!
## License
The MIT license. See `LICENSE`.
Copyright (c) 2018 Jacob Gillespie
Copyright (c) 2013–2016 Brian J. Brennan