@birchill/jpdict-idb
TypeScript icon, indicating that this package has built-in type declarations

2.6.1 • Public • Published

Usage

NOTE: There are TWO versions of the database:

  • JpdictDatabase which does not allow searching for words by their glosses (e.g. searching for "eat" to find 食べる) or searching for words that contain particular a particular kanji.

    i.e. getWordsWithGloss and getWordsWithKanji will always return an empty result when using this database.

  • JpdictFullTextDatabase which does allow searching for words on gloss or kanji.

Currently you need to decide once when you create the database which version you need. There is no facility to switch between the two.

The reason is that the indices for searching for glosses / kanji are expensive to create and take up disk space, and some applications (e.g. 10ten Japanese Reader) simply don't need them.

Furthermore, hopefully the project is structured such that if you only use JpdictDatabase then after tree-shaking your final bundle should not include all the tokenization / stop word code for generating and querying the gloss indices.

Building

pnpm build

Running tests

pnpm test

Testing using Firefox / WebKit:

pnpm test --browser firefox
pnpm test --browser webkit

Publishing

pnpm release-it

Readme

Keywords

none

Package Sidebar

Install

npm i @birchill/jpdict-idb

Weekly Downloads

136

Version

2.6.1

License

none

Unpacked Size

892 kB

Total Files

8

Last publish

Collaborators

  • birtles