mifo

# mifo
__Micro formats encoder and decoder.__


> If links in this document not avaiable, please access README on GitHub directly.

Description

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

## Table of Contents

* Get Started
* API
* Micro Formats
* base64
* urlencode
* 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.\.encode__(string text*)
string | null __mifo.\.decode__(string code*)

## Micro Formats

$3

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

$3

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

## Links

* CHANGE LOG
* Homepage