npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@scriptin/jmdict-simplified-types

v3.6.1

Published

TypeScript type definitions for jmdict-simplified - JMdict, JMnedict, Kanjidic in JSON format

Downloads

130

Readme

TypeScript types for jmdict-simplified

Download JSON files Format documentation

npm install --save-dev @scriptin/jmdict-simplified-types

Includes types for JSON files in jmdict-simplified:

  • JMdict
  • JMnedict
  • Kanjidic
  • KRADFILE/RADKFILE

Usage

Option 1: using JSON files directly

Install the types:

npm install --save-dev @scriptin/jmdict-simplified-types

You should use --save-dev because this package only includes type definitions and no code.

With Node.js:

// app.ts
import type { Kanjidic2 } from "@scriptin/jmdict-simplified-types";

const json = JSON.parse(
  readFileSync('path/to/kanjidic2-1.2.3.json', { encoding: 'utf-8' })
) as Kanjidic2;

Note Some JSON files can be large and won't fit into memory, but it should work fine for Kanjidic, JMnedict, KRADFILE/RADKFILE, and filtered (by language or "common-only") versions of JMdict

With bundlers (e.g. Webpack, Vite) which support importing JSON via loaders/plugins:

// app.ts
import type { Kanjidic2 } from "@scriptin/jmdict-simplified-types";
import kanjidicJson from "path/to/kanjidic2-1.2.3.json";

const kanjidic = kanjidicJson as Kanjidic2;

Option 2: using @scriptin/jmdict-simplified-loader

This method works with server only, and allows you to import JSON files (e.g. load into a database) using a streaming JSON parser, which doesn't load the whole file into memory. This is ideal when working with full version of JMdict JSON file, but works for JMnedict and Kanjidic as well.

Install the loader:

npm install @scriptin/jmdict-simplified-loader

You can skip installing the types because @scriptin/jmdict-simplified-loader includes types as a dependency. Unless you separate "loading" and "using" phases into separate apps/scripts with separate dependencies.

Process the data using the simple event API (uses JSON streaming API under the hood):

// load-jmdict.ts
import { loadDictionary } from "@scriptin/jmdict-simplified-loader";

const loader = loadDictionary("jmdict", "path/to/jmdict-1.2.3.json")
  .onMetadata((metadata) => {
    // Process metadata
  })
  .onEntry((entry, metadata) => {
    // Load an entry into database
  })
  .onEnd(() => {
    console.log("Finished!");
  });

// To handle parsing errors:
loader.parser.on('error', (error) => {
  console.error(error);
});