ipa-jfk/src/index.js

IPA narrow transcription of English words in New York City accent

/* Copyright (C) 2020-2021 b1f6c1c4
 *
 * This file is part of IPA-JFK.
 *
 * IPA-JFK is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, version 3.
 *
 * IPA-JFK is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with IPA-JFK.  If not, see <https://www.gnu.org/licenses/>.
 */

import parse from './parse.js';
import syllable from './syllable.js';
import vowel from './vowel.js';
import consonant from './consonant.js';
export * as display from './display.js';

export default (ph, word, phonemic, { aeHint, syllableHint } = {}) => {
  let phs = parse(ph);
  phs = syllable(phs, syllableHint, phonemic);
  if (phonemic) {
    phs.phonemic = true;
    return phs;
  }
  phs = vowel(phs, word.toUpperCase(), aeHint);
  phs = consonant(phs, word.toUpperCase());
  return phs;
};