# mifo

> Micro formats encoder and decoder.

Latest version **0.0.2** (published 2018-06-04) · 0 weekly downloads

## Install

```sh
npm install mifo
pnpm add mifo
yarn add mifo
bun add mifo
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-06-04 |
| First published | 2018-06-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | YounGoat |
| Maintainers | youngoat |
| Keywords | micro-format, base64, url-encode |

## Links

- npm: https://www.npmjs.com/package/mifo
- Repository: https://github.com/YounGoat/ecmascript.mifo
- Issues: https://github.com/YounGoat/ecmascript.mifo/issues
- npm.io page: https://npm.io/package/mifo

## Dependencies (1)

- [noda](https://npm.io/package/noda.md) ^0.5.0

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2018-06-04
- 0.0.1 — 2018-06-04

## README

#	mifo
__Micro formats encoder and decoder.__

[![total downloads of mifo](https://img.shields.io/npm/dt/mifo.svg)](https://www.npmjs.com/package/mifo)
[![mifo's License](https://img.shields.io/npm/l/mifo.svg)](https://www.npmjs.com/package/mifo)
[![latest version of mifo](https://img.shields.io/npm/v/mifo.svg)](https://www.npmjs.com/package/mifo)

>	If links in this document not avaiable, please access [README on GitHub](https://github.com/YounGoat/ecmascript.mifo/blob/master/README.md) directly.

##  Description

In this package, we defined some self-describing text formats.

##	Table of Contents

* [Get Started](#get-started)
* [API](#api)
* [Micro Formats](#micro-formats)
	* [base64](#base64)
	* [urlencode](#urlencode)
* [Links](#links)

##	Get Started

```javascript
const mifo = require('mifo');

// Encode the string into base64 format with self-describing heading.
mifo.base64.encode('青青子衿');
// RETURN: Base64006Z2S6Z2S5a2Q6KG
¡ 
mifo.base64.decode('Base64006Z2S6Z2S5a2Q6KG');
// RETURN: 青青子衿
```

##  API

*   string | null __mifo.decode__(string *code*)  
    Automatically judge the micro-format of *code* and decode it with corresponding method.

__mifo__ offers two methods for each micro format:
*   string __mifo.\<formatName\>.encode__(string *text*)
*   string | null __mifo.\<formatName\>.decode__(string *code*)

##	Micro Formats

### base64

*   string __mifo.base64.encode__(string *text*)
*   string | null __mifo.base64.decode__(string *code*)

### urlencode

*   string __mifo.urlencode.encode__(string *text*)
*   string | null __mifo.urlencode.decode__(string *code*)

##	Links

*	[CHANGE LOG](./CHANGELOG.md)
*	[Homepage](https://github.com/YounGoat/ecmascript.mifo)

---
_Source: https://npm.io/package/mifo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._