Giter Site home page Giter Site logo

nbsa / xmorse Goto Github PK

View Code? Open in Web Editor NEW

This project forked from hustcc/xmorse

0.0 1.0 0.0 18 KB

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

Home Page: http://git.hust.cc/xmorse

License: MIT License

JavaScript 77.66% HTML 22.34%

xmorse's Introduction

Xmorse

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

中文说明文档 | Online DEMO 地址

Build Status Coverage Status npm npm npm

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.