{"id":24582729,"url":"https://github.com/crizmo/japanese-easy","last_synced_at":"2026-02-11T15:33:24.281Z","repository":{"id":270448524,"uuid":"910416192","full_name":"crizmo/japanese-easy","owner":"crizmo","description":"A comprehensive toolkit for learning and working with Japanese Kanji, Kana, and vocabulary data, complete with charts, readings, and utility functions.","archived":false,"fork":false,"pushed_at":"2025-01-15T17:20:05.000Z","size":23,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-01T11:38:14.475Z","etag":null,"topics":["hiragana","japanese","japanese-language","jlpt","kana","kanji","katakana","language-resources","npm","reading","vocabulary"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/japanese-easy","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crizmo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-31T08:02:03.000Z","updated_at":"2025-01-15T17:20:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"d4a89fb0-6834-4b80-86be-1ed505d89c38","html_url":"https://github.com/crizmo/japanese-easy","commit_stats":null,"previous_names":["crizmo/japanese-easy"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/crizmo/japanese-easy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crizmo%2Fjapanese-easy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crizmo%2Fjapanese-easy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crizmo%2Fjapanese-easy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crizmo%2Fjapanese-easy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crizmo","download_url":"https://codeload.github.com/crizmo/japanese-easy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crizmo%2Fjapanese-easy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29336869,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T14:34:07.188Z","status":"ssl_error","status_checked_at":"2026-02-11T14:34:06.809Z","response_time":97,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hiragana","japanese","japanese-language","jlpt","kana","kanji","katakana","language-resources","npm","reading","vocabulary"],"created_at":"2025-01-24T03:56:45.212Z","updated_at":"2026-02-11T15:33:24.264Z","avatar_url":"https://github.com/crizmo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Japanese-easy\n\n`japanese-easy` is a utility package designed to make it easier to work with Japanese Kana and Kanji data. This package provides functions for fetching Kanji and Kana information, converting Kanji to Kana, retrieving Kanji lists, and accessing Hiragana and Katakana charts.\n\n## Features\n\n- Lookup Kanji data, including meanings, readings, and more.\n- Lookup Kana (Hiragana/Katakana) details.\n- Convert Kanji to Kana for better understanding of pronunciation.\n- Retrieve a list of Kanji based on grades or other filters.\n- Access complete Hiragana and Katakana charts.\n- Lookup specific words and their meanings.\n- Lookup random words or words by JLPT level.\n- Retrieve all available words, optionally filtered by level.\n\n---\n\n## Installation\n\nInstall the package via npm:\n\n```bash\nnpm install japanese-easy\n```\n\n---\n\n## Usage\n\nHere are examples of how to use the `japanese-easy` package:\n\n### Importing the Package\n\n```javascript\nimport * as japanese_easy from 'japanese-easy';\n```\n\n### Lookup Kanji Data\n\n```javascript\njapanese_easy.lookupKanji('猫').then(data =\u003e {\n    console.log(\"Result from lookupKanji:\", data);\n});\n```\n\n### Lookup Kana Data\n\n```javascript\njapanese_easy.lookupKana('あ').then(data =\u003e {\n    console.log(\"Result from lookupKana:\", data);\n});\n```\n\n### Convert Kanji to Kana\n\n```javascript\njapanese_easy.convertKanjiToKana('猫').then(data =\u003e {\n    console.log(\"Result from convertKanjiToKana:\", data);\n});\n```\n\n### Lookup Kanji List\n\n```javascript\njapanese_easy.lookupKanjiList('grade-1').then(data =\u003e {\n    console.log(\"Result from lookupKanjiList:\", data);\n});\n```\n\n### Get Hiragana Chart\n\n```javascript\njapanese_easy.getHiraganaChart().then(data =\u003e {\n    console.log(\"Result from getHiraganaChart:\", data);\n});\n```\n\n### Get Katakana Chart\n\n```javascript\njapanese_easy.getKatakanaChart().then(data =\u003e {\n    console.log(\"Result from getKatakanaChart:\", data);\n});\n```\n\n### Lookup Specific Word\n\n```javascript\njapanese_easy.lookupWord('夜更かし').then(data =\u003e {\n    console.log(\"Result from lookupWord:\", data);\n});\n```\n\n### Lookup Words by JLPT Level\n\n```javascript\njapanese_easy.lookupWordsByLevel(3).then(data =\u003e {\n    console.log(\"Result from lookupWordsByLevel (N3):\", data);\n});\n```\n\n### Lookup Random Word\n\n```javascript\njapanese_easy.lookupRandomWord().then(data =\u003e {\n    console.log(\"Result from lookupRandomWord:\", data);\n});\n```\n\n### Lookup Random Word by Level\n\n```javascript\njapanese_easy.lookupRandomWord(1).then(data =\u003e {\n    console.log(\"Result from lookupRandomWord (N1):\", data);\n});\n```\n\n### Lookup All Words\n\n```javascript\njapanese_easy.lookupAllWords().then(data =\u003e {\n    console.log(\"Result from lookupAllWords:\", data);\n});\n```\n\n### Fetch All Words by Level\n\n```javascript\njapanese_easy.lookupAllWords(3).then(data =\u003e {\n    console.log(\"Result from lookupAllWords (N3):\", data);\n});\n```\n\n---\n\n## API Reference\n\n### `lookupKanji(kanji: string): Promise\u003cObject\u003e`\nFetches detailed information about a given Kanji.\n\n- **Parameter:** `kanji` - The Kanji character to lookup.\n- **Returns:** A Promise resolving to Kanji data.\n\n---\n\n### `lookupKana(kana: string): Promise\u003cObject\u003e`\nFetches information about a given Kana (Hiragana or Katakana).\n\n- **Parameter:** `kana` - The Kana character to lookup.\n- **Returns:** A Promise resolving to Kana data.\n\n---\n\n### `convertKanjiToKana(text: string): Promise\u003cstring\u003e`\nConverts a string of Kanji into Kana for better pronunciation.\n\n- **Parameter:** `text` - A string containing Kanji.\n- **Returns:** A Promise resolving to the Kana equivalent.\n\n---\n\n### `lookupKanjiList(filter: string): Promise\u003cArray\u003e`\nFetches a list of Kanji based on a specified filter (e.g., grade level).\n\n#### Available Parameters for `lookupKanjiList`\n\nThe `lookupKanjiList` function supports the following categories as parameters:\n\n- `joyo` or `jouyou`: List of Jōyō Kanji.\n- `jinmeiyo` or `jinmeiyou`: List of Jinmeiyō Kanji.\n- `heisig`: List of Kanji with a Heisig keyword.\n- `kyouiku` or `kyouiku`: List of all Kyōiku Kanji.\n- `grade-1`: List of Grade 1 Kyōiku Kanji.\n- `grade-2`: List of Grade 2 Kyōiku Kanji.\n- `grade-3`: List of Grade 3 Kyōiku Kanji.\n- `grade-4`: List of Grade 4 Kyōiku Kanji.\n- `grade-5`: List of Grade 5 Kyōiku Kanji.\n- `grade-6`: List of Grade 6 Kyōiku Kanji.\n- `grade-8`: List of Jōyō Kanji excluding Kyōiku Kanji.\n- `all`: List of all 13,000+ available Kanji.\n\n- **Parameter:** `filter` - A string filter such as \"grade-1\".\n- **Returns:** A Promise resolving to an array of Kanji.\n\n---\n\n### `lookupWord(word: string): Promise\u003cObject\u003e`\nFetches detailed information about a specific word.\n\n- **Parameter:** `word` - The word to lookup.\n- **Returns:** A Promise resolving to word data.\n\n---\n\n### `lookupWordsByLevel(level: number): Promise\u003cArray\u003e`\nFetches words by their JLPT level.\n\n- **Parameter:** `level` - The JLPT level (e.g., 1, 2, 3, 4, 5).\n- **Returns:** A Promise resolving to an array of words.\n\n---\n\n### `lookupRandomWord(level?: number): Promise\u003cObject\u003e`\nFetches a random word, optionally filtered by JLPT level.\n\n- **Parameter:** `level` - The JLPT level (optional).\n- **Returns:** A Promise resolving to a random word.\n\n---\n\n### `lookupAllWords(level?: number): Promise\u003cArray\u003e`\nFetches all available words, optionally filtered by JLPT level.\n\n- **Parameter:** `level` - The JLPT level (optional).\n- **Returns:** A Promise resolving to an array of words.\n\n---\n\n### `getHiraganaChart(): Promise\u003cObject\u003e`\nFetches the complete Hiragana chart.\n\n- **Returns:** A Promise resolving to a Hiragana chart object.\n\n---\n\n### `getKatakanaChart(): Promise\u003cObject\u003e`\nFetches the complete Katakana chart.\n\n- **Returns:** A Promise resolving to a Katakana chart object.\n\n---\n\n## Scripts\n\n### Running Tests\n\nTo run tests for the package, use:\n\n```bash\nnpm run test\n```\n\nThis will execute the `tests/core.js` file.\n\n---\n\n## Japanese Easy Website\nFor more information, visit the [Japanese Easy](https://japanese-easy.vercel.app/) website.\n\n---\n\n## Contributing\n\nContributions are welcome! If you have suggestions or find bugs, feel free to open an issue or submit a pull request on [GitHub](https://github.com/crizmo/japanese-easy).\n\n---\n\n## Issues\n\nIf you encounter any problems, please report them at the [issues page](https://github.com/crizmo/japanese-easy/issues).\n\n---\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](https://github.com/crizmo/japanese-easy/blob/main/LICENSE) file for details.\n\n---\n\n## Author\n\nDeveloped by **Kurizu**.\n\n- GitHub: [@crizmo](https://github.com/crizmo)\n\n---\n\n## Links\n\n- [Repository](https://github.com/crizmo/japanese-easy)\n- [Issues](https://github.com/crizmo/japanese-easy/issues)\n- [Homepage](https://github.com/crizmo/japanese-easy#readme)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrizmo%2Fjapanese-easy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrizmo%2Fjapanese-easy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrizmo%2Fjapanese-easy/lists"}