Phonetical provides the ability to translate text into a phonetic alphabet string.
This project is still in development. Please report any bugs or feature requests as an issue.
You can get started with cloning the Phonetical repository by using the following command:
$ git clone git@github.com:ToeFungi/phonetical.git
$ cd phonetical
$ npm i
Use the following command to install the Phonetical package:
npm i phonetical
Convert a string to a phonetic alphabet string.
import { Phonetical, InternationalDictionary } from './Phonetical'
const text = 'Hello there'
const natoTranslation = Phonetical.toPhonetics(text)
const internationalTranslation = Phonetical.toPhonetics(text, InternationalDictionary)
The library comes with various predefined dictionaries which can be used to translate text into a phonetic string.
To run tests, you should be able to simply run be able to run the following.
$ npm run test
$ npm run coverage
The testing framework used is Mocha. Chai and nyc are used for assertions and coverage reporting respectively. Ensure that any new changes are covered by an accompanying test suite.
If you find any problems while working with this library, please log an issue here so that development can begin to rectify the error.
This project is completely open source and as such, you are invited to make contributions. Fork the project, make some changes and make the pull request. If you have any feedback regarding the functionality, please don't hesitate to open an issue so this can be resolved. Please ensure that any pull requests have unit tests that cover any additional functionality.
MIT License
Copyright (c) 2021 Alex Pickering
FAQs
Phonetical is a library to convert text to a phonetic alphabet string
The npm package phonetical receives a total of 5 weekly downloads. As such, phonetical popularity was classified as not popular.
We found that phonetical demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.