Mr-Zhang / xmorse

:sun_with_face: Pure javascript / nodejs library (~1.5 kb) for encode / decode morse code messages, unicode supported. 一个支持 unicode 中文摩斯密码编码的 Javascript 库。

Xmorse

Xmorse is a pure javascript(~1.5kb) library for encoding / decoding morse code messages, unicode supported.

中文说明文档 | Online DEMO 地址

1. Install

npm install xmorse

Or download dist/xmorse.min.js source file。

2. Import It

• Script tag.

<script type="text/javascript" src="dist/xmorse.min.js"></script>

• ES6 style.

var xmorse = require('xmorse');

//or

import xmorse from 'xmorse';

3. Usage & API

There is only 2 API named encode, decode.

For encode(msg, [option]), example:

// standart morse
xmorse.encode('Hello, Xmorse!');
  
// unicode
xmorse.encode('コンニチハ, セカイ!');
xmorse.encode('越过长城，走向世界');

// option
var option = {
  space: ' ',
  long: '-',
  short: '*'
};
xmorse.encode('越过长城，走向世界', option);

For decode(morse, [option]), example:

xmorse.decode('../.-../---/...-/./-.--/---/..-/-/---/---/--...-....-...-/-..---..-.-----/---..-...--...-/-..----.--.....');

// option
var option = {
  space: ' ',
  long: '-',
  short: '*'
};
xmorse.decode('*-** --- ***- *', option);

4. Test

npm install

npm test

5. LICENSE

MIT@hustcc