https://github.com/jhermsmeier/node-nysiis-phonetics

NYSIIS phonetic code algorithm
https://github.com/jhermsmeier/node-nysiis-phonetics

nysiis phonetic-algorithm phonetics

Last synced: 22 days ago
JSON representation

NYSIIS phonetic code algorithm

• Host: GitHub
• URL: https://github.com/jhermsmeier/node-nysiis-phonetics
• Owner: jhermsmeier
• License: mit
• Created: 2015-02-14T16:25:26.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-10-18T01:05:16.000Z (about 7 years ago)
• Last Synced: 2024-04-25T03:02:04.419Z (7 months ago)
• Topics: nysiis, phonetic-algorithm, phonetics
• Language: JavaScript
• Size: 8.79 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# NYSIIS (New York State Identification and Intelligence System) Phonetic Code

[![npm](http://img.shields.io/npm/v/nysiis-phonetics.svg?style=flat-square)](https://npmjs.com/nysiis-phonetics)

[![npm downloads](http://img.shields.io/npm/dm/nysiis-phonetics.svg?style=flat-square)](https://npmjs.com/nysiis-phonetics)

[![build status](http://img.shields.io/travis/jhermsmeier/node-nysiis-phonetics.svg?style=flat-square)](https://travis-ci.org/jhermsmeier/node-nysiis-phonetics)

## Install via [npm](https://npmjs.com)

```sh

$ npm install nysiis-phonetics

```

## About

The **New York State Identification and Intelligence System** Phonetic Code, commonly known as **NYSIIS**, is a phonetic algorithm devised in 1970 as part of the New York State Identification and Intelligence System (now a part of the New York State Division of Criminal Justice Services). It features an accuracy increase of 2.7% over the traditional Soundex algorithm.

See [Wikipedia](https://en.wikipedia.org/wiki/New_York_State_Identification_and_Intelligence_System)

## Usage

```js

var nysiis = require( 'nysiis-phonetics' )

```

## API

#### `nysiis( value, [truncate] ) -> String`

- **String** value

- **Boolean** truncate, defaults to `true`