metaphone

метафон

Метафонный фонетический алгоритм.

Содержание

• Что это?
• Когда мне следует это использовать?
• Установить
• Использовать
• API
  • metaphone(value)
• интерфейс командной строки
• Типы
• Совместимость
• Связанный
• Способствовать
• Безопасность
• Лицензия

Что это?

Этот пакет предоставляет фонетический алгоритм. Это означает, что он получает определенную строку (обычно английское слово) и превращает ее в код, который затем можно сравнить с другими кодами (других слов), чтобы проверить, одинаково ли они (вероятно) произносятся.

Когда мне следует это использовать?

Вероятно, вы имеете дело с естественным языком и знаете, что вам это нужно, если вы здесь!

В зависимости от ваших потребностей, double-metaphone может быть лучше.

В зависимости от ваших целей вы, вероятно, захотите дополнительно использовать стеммер (например, stemmer ).

Установить

Этот пакет предназначен только для ESM. В Node.js (версии 14.14+, 16.0+) установите с помощью npm:

npm install metaphone

В Deno с esm.sh :

 import { metaphone } from 'https://esm.sh/metaphone@2'

В браузерах с esm.sh :

 < script type =" module " >
  import { metaphone } from 'https://esm.sh/metaphone@2?bundle'
</ script > 

Использовать

 import { metaphone } from 'metaphone'

metaphone ( 'michael' ) // => 'MXL'
metaphone ( 'crevalle' ) // => 'KRFL'
metaphone ( 'Filipowitz' ) // => 'FLPWTS'
metaphone ( 'Xavier' ) // => 'SFR'
metaphone ( 'delicious' ) // => 'TLSS'
metaphone ( 'acceptingness' ) // => 'AKSPTNKNS'
metaphone ( 'allegrettos' ) // => 'ALKRTS'

Со stemmer :

 import { metaphone } from 'metaphone'
import { stemmer } from 'stemmer'

metaphone ( stemmer ( 'acceptingness' ) ) // => 'AKSPTNK'
metaphone ( stemmer ( 'allegrettos' ) ) // => 'ALKRT' 

API

Этот пакет экспортирует идентификатор metaphone . Экспорта по умолчанию нет.

metaphone(value)

Получите код метафона по заданному значению.

value

Используемое значение ( string , обязательно).

Возврат

Метафонный код value ( string ).

интерфейс командной строки

Usage: metaphone [options] <words...>

Metaphone implementation

Options:

  -h, --help           output usage information
  -v, --version        output version number

Usage:

# output phonetics
$ metaphone considerations detestable
# KNSTRXNS TTSTBL

# output phonetics from stdin
$ echo 'hiccups vileness' | metaphone
# HKKPS FLNS

# with stemmer
$ echo 'vileness' | stemmer | metaphone
# FL 

Типы

Этот пакет полностью набран с помощью TypeScript. Он не экспортирует никаких дополнительных типов.

Совместимость

Этот пакет как минимум совместим со всеми поддерживаемыми версиями Node.js. На данный момент это Node.js 14.14+ и 16.0+. Он также работает в Deno и современных браузерах.

Связанный

• double-metaphone — алгоритм двойного метафона
• soundex-code — алгоритм soundex
• stemmer — алгоритм стеммера Портера
• dice-coefficient — коэффициент Соренсена-дайса
• levenshtein-edit-distance — расстояние редактирования Левенштейна
• syllable — количество слогов в английских словах

Способствовать

Да, пожалуйста! См. раздел «Как внести свой вклад в открытый исходный код».

Безопасность

Этот пакет безопасен.

Лицензия

Массачусетский технологический институт © Титус Уормер