npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

phonetical

v0.1.0

Published

Phonetical is a library to convert text to a phonetic alphabet string

Downloads

8

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

toefungitoefungi

Keywords

phoneticalphabetgermanenglishnatoitalianinternationalamericantranslationcommunicationradiotransmission

Readme

Phonetical

NPM Version Quality Gate Status Coverage Code Smells Vulnerabilities

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.

Contents

Getting Started

You can get started with cloning the Phonetical repository by using the following command:

$ git clone [email protected]:ToeFungi/phonetical.git
$ cd phonetical
$ npm i

Installation

Use the following command to install the Phonetical package:

npm i phonetical

Usage

.toPhonetics(text, dictionary)

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)

Dictionaries

The library comes with various predefined dictionaries which can be used to translate text into a phonetic string.

Tests

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.

Issues

If you find any problems while working with this library, please log an issue here so that development can begin to rectify the error.

Contributions

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.

License

MIT License

Copyright (c) 2021 Alex Pickering