kanji.js/index.d.ts

漢字 search/lookup library for Node.js and browsers

export as namespace Kanji;

export default class Kanji {
  name: string;
  version: string;
  constructor ();

  static dump () : Array<Kanji.Word>;
  static getDetails (character: string) : Kanji.Word;
  static search (options?: Kanji.SearchOptions) : Array<Kanji.Word>;
  static random () : Kanji.Word;
}

export interface Word {
  freq: number;
  grade: number;
  jlpt: number;
  kunyomi: Array<string>;
  literal: string;
  meanings: Array<string>;
  onyomi: Array<string>;
  stroke_count: number;
}

export interface SearchOptions {
  grade?: Kanji.RangeOption | number;
  jlpt?: Kanji.RangeOption | number;
  meaning?: string;
  romaji?: string;
  sort?: boolean;
}

export interface RangeOption {
  min?: number;
  max?: number;
}