@n00p3/ve-js

A linguistic framework for anyone. No degree required.

Usage no npm install needed!

<script type="module">
  import n00p3VeJs from 'https://cdn.skypack.dev/@n00p3/ve-js';
</script>

README

ve-js

A linguistic framework for anyone. No degree required.

Port of ve to JavaScript.

It uses kuromoji as it's backend. All required dictionaries are included in ./lib directory.

How to install

npm i @n00p3/ve-js
# or
yarn add @n00p3/ve-js

How to use

const Ve = require('@n00p3/ve-js');

// As a first argument you can pass a path to directory with dictionaries.
const ve = new Ve();
const words = await ve.words('答えてくれるはず');

/*
[
  Word {
    tokens: [ [Object], [Object], [Object] ],
    reading: 'コタエテクレル',
    transcription: 'コタエテクレル',
    grammar: 'Unassigned',
    lemma: '答える',
    partOfSpeech: 'Verb',
    word: '答えてくれる'
  },
  Word {
    tokens: [ [Object] ],
    reading: 'ハズ',
    transcription: 'ハズ',
    grammar: 'Unassigned',
    lemma: 'はず',
    partOfSpeech: 'Noun',
    word: 'はず'
  }
]
*/