# base64-min
> Minimalist package, focused in best performance to encode and decode base64.
Latest version **2.0.0** (published 2017-04-28) · MIT license · 0 weekly downloads
## Install
```sh
npm install base64-min
pnpm add base64-min
yarn add base64-min
bun add base64-min
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2017-04-28 |
| First published | 2015-04-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Victor Fernandes |
| Maintainers | victorfern91 |
| Keywords | base64, minimal, files, encryption, fast, crypto, xor, cipher, MIME |
## Links
- npm: https://www.npmjs.com/package/base64-min
- Repository: https://github.com/victorfern91/base64
- Issues: https://github.com/victorfern91/base64/issues
- npm.io page: https://npm.io/package/base64-min
## Alternatives
- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads
## Recent versions
- 2.0.0 (latest) — 2017-04-28
- 1.2.0 — 2016-09-16
- 1.1.0 — 2016-01-30
- 0.6.0 — 2015-11-21
- 0.5.3 — 2015-11-19
- 0.5.2 — 2015-05-10
- 0.5.1 — 2015-05-10
- 0.5.0 — 2015-05-10
- 0.4.1 — 2015-04-08
- 0.4.0 — 2015-04-08
- 0.3.0 — 2015-04-08
- 0.2.2 — 2015-04-05
- 0.2.1 — 2015-04-04
- 0.2.0 — 2015-04-04
- 0.1.1 — 2015-04-01
- … 2 more at https://npm.io/package/base64-min/versions
## README
# base64 (npm base64-min)
[](https://travis-ci.org/victorfern91/base64)
[](https://coveralls.io/github/victorfern91/base64?branch=master)
**Disclaimer: For node versions < 4 use the 1.2.0 version.**
This modules can be used to encoding & decoding messages (strings) and files using base64.
I'm trying to add new features based on other packages to get an all in one npm module.
Actually **base64-min** can encode and decode: **strings**, **files** and **strings with XOR encrytion**.
[](https://nodei.co/npm/base64-min/)
## Why use this module?
It's minimalist and focused in the best javascript performance.
### Install base64-min module
At cmd, type:
```
$ npm install base64-min
```
or to install this package globally, use:
```
$ npm install -g base64-min
```
### After install run unit tests
```
$ cd ./node_modules/base64-min/
$ npm install
$ npm test
```
### Do you want a test report?
```
$ cd ./node_modules/base64-min/
$ npm install
$ npm test --coverage
```
## How to use?
To load module functionalities, you must use the require.js properties integrated in node.js.
Example:
```javascript
var base64 = require('base64-min');
```
### DOCS
##### encode (str)
This method is used to encode a plain-text string to a encoded string in base64.
- **Arguments :**
- ```str``` - The string you want to encode.
- ```type``` - Encoding Type (This argument is optional) | Available types: 'MIME'.
- **Result :** Encoded string in base64.
- **Example :**
```javascript
base64.encode('base64-min npm module'); // result = YmFzZTY0LW1pbiBucG0gbW9kdWxl
base64.encode('base64-min npm module', 'MIME'); // result = YmFzZTY0LW1pbiBucG0gbW9kdWxl
// encoded string in base64, using MIME constraints
```
##### decode (str)
This method is used to decode a the base64 message to a plain-text string.
- **Arguments :**
- ```str``` - The message (in base64) you want to decode.
- **Result :** Our message decoded in plain-text.
- **Example :**
```javascript
base64.decode('YmFzZTY0LW1pbiBucG0gbW9kdWxl'); // result = base64-min npm module
```
##### encodeFile(file)
This method is used to encode files into base64 string.
- **Arguments :**
- ```file``` - The file path of the you want to encode.
- **Result :** Encoded File into a string in base64.
- **Example :**
```javascript
base64.encodeFile('original.png');
```
##### decodeToFile(str,filepath)
This method is used to decode messages and save the result in one file (Tested and functional with PNG Files).
- **Arguments :**
- ```str``` - The message (in base64) you want to decode.
- ```file``` - The file path of the you want to save.
- **Result :** Decoded File
- **Example :**
```javascript
base64.decodeToFile('ZGF0YQ==', 'result.png') ;
```
##### encodeWithKey(str,key)
This method is used to encode messages and encrypt messages using a key (XOR Encryption - Fast and "Secure").
- **Arguments :**
- ```str``` - The message in plain-text.
- ```key``` - The key you want to encrypt your message.
- **Result :** Encoded encrypted message in base64.
- **Example :**
```javascript
base64.encodeWithKey('base64-min npm module', 'victorfern91'); // result = FAgQEVlGSwgbABlfBgRDGQAWEwkX
//(in plain text is YFK_C )
```
##### decodeWithKey(str,key)
- **Arguments :**
- ```str``` - The message in base64.
- ```key``` - The key used to encrypt this message.
- **Result :** Deciphered message in plain-text.
- **Example :**
```javascript
//Decoding with wrong key
base64.decodeWithKey('FAgQEVlGSwgbABlfBgRDGQAWEwkX', 'npm module'); // result = zx}14)/}wew/k$.vdcly
//Decoding with correct key
base64.decodeWithKey('FAgQEVlGSwgbABlfBgRDGQAWEwkX', 'victorfern91'); // result = base64-min npm module
```
---
_Source: https://npm.io/package/base64-min · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._