The library provides a very simple API
that exposes the simple translation functionality while only exposing a single global variable (
The predefined phonetic alphabet is based on the ITU
but Phony allows this to be easily extended by adding and/or modifying characters.
Install using the package manager for your desired environment(s):
The API has been completely redesigned to
simplify translating to and from the phonetic alphabet by simply passing a string to the
Both of which also accept an optional
options parameter which can currently contain the following (all of
which are optional themselves):
|alphabet||Name of the alphabet to be used to translate the message||
|cache||Whether to cache built alphabets||
|letterSplitter||Sequence of characters to split letters||
|wordSplitter||Sequence of characters to split words||
It's important to note that the same options should be used in order for bidirectional translations to work. Some of
these strings are used to build regular expressions (or can be regular expressions), so it's recommended to
familiarized yourself with the usage of the options before change them, just so you know on which you need to escape
RegExp special characters.
If you installed
node-phony globally using npm you can use this libraries built-in command line
Usage: phony [options] [command] Commands: from <message> translates the message to the phonetic alphabet to <message> translates the message from the phonetic alphabet Options: -h, --help output usage information -V, --version output the version number -a, --alphabet [name] name of the alphabet to be used -l, --letter-splitter [value] sequence of characters to split letters -w, --word-splitter [value] sequence of characters to split words
message parameter to the phonetic alphabet.
message parameter from the phonetic alphabet.
Alphabets are key to translating messages to and from the phonetic alphabet as they contain characters use to find and replace phonetic representations in the message. Alphabets can declare fallback alphabets so that, if it does not contain a matching character or phonetic representation, it will attempt to look it up from the fallback alphabet, and so on. For this reason, if you plan on creating a custom alphabet, it's recommended that you always specify a fallback alphabet.
Here's a list of the built in alphabets:
- itu (default)
Adding a new alphabet is as simple as the following:
Clears any previously built alphabets that may have been cached by
This can be useful when making modifications to alphabets and having them picked up.
The cache can also be bypassed by using the
This is a hash of default values to be applied to the optional
options parameter and exposed to allow you
to override any of them.
phony in a no-conflict state, reallocating the
phony global variable name to its
previous owner, where possible.
This is really just intended for use within a browser.
The current version of
View historical changes
- #8: Add command-line interface
If you have any problems with this library or would like to see changes currently in development you can do so here.
If you want to contribute, you're a legend! Information on how you can do so can be found in CONTRIBUTING.md. We want your suggestions and pull requests!
A list of Phony contributors can be found in AUTHORS.md.
Copyright © 2015 Alasdair Mercer
See LICENSE.md for more information on our MIT license.