https://github.com/ecto/morse
:heavy_minus_sign: simple Morse code library for node
https://github.com/ecto/morse
Last synced: about 1 year ago
JSON representation
:heavy_minus_sign: simple Morse code library for node
- Host: GitHub
- URL: https://github.com/ecto/morse
- Owner: ecto
- License: mit
- Created: 2012-06-20T00:05:59.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2016-02-22T19:20:11.000Z (over 10 years ago)
- Last Synced: 2025-03-29T05:01:44.076Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 190 KB
- Stars: 62
- Watchers: 4
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#morse
A simple Morse code library for node
## install
For use as a CLI:
npm install -g morse
For use as a library:
npm install morse
## example usage as a CLI
````
$ morse -h
Usage: morse [options] string
Options:
-d, --decode Decode a string of Morse code [boolean]
-h, --help Show this text
$ morse hello > hello.txt
$ morse -d "`cat hello.txt`"
HELLO
````
## example usage as a library
````javascript
var morse = require('morse');
var encoded = morse.encode('Hello, world.');
// .... . .-.. .-.. --- --..-- ....... .-- --- .-. .-.. -.. .-.-.-
morse.decode(encoded);
// HELLO, WORLD.
````
````javascript
var encoded = morse.encode([ 'hello', 'world' ]);
// [ '.... . .-.. .-.. ---', '.-- --- .-. .-.. -..' ]
morse.decode(encoded);
// [ 'HELLO', 'WORLD' ]
````
## methods
### morse.encode(obj)
Encodes and returns a given string or array
### morse.decode(obj, dichotomic)
Decodes and returns a string or array
`dichotomic` defaults to false. If passed true, it will use a tree-based approach to decode the string or array. If false, a basic iteration of the map is used.
The dichotomic approach looks like this:
The implementation does not include spaces right now, so it fails its test. However, it is otherwise accurate.
````javascript
morse.decode(
morse.encode('Hello, world.'),
true
);
// HELLO,5WORLD.
````
## attributes
### morse.map
An object containing `letter: morse` translations contained in `map.js`
### morse.tree
A tree-modeled object contained in `tree.js`
## license
MIT