henkan 2.4.12 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/README.md +1 -1
  2. package/dist/index.cjs.js +439 -46
  3. package/dist/index.cjs.js.map +2 -2
  4. package/dist/index.mjs +436 -46
  5. package/dist/index.mjs.map +2 -2
  6. package/dist/types/types.d.ts +106 -15
  7. package/dist/types/types.d.ts.map +1 -1
  8. package/dist/types/utils.d.ts +28 -6
  9. package/dist/types/utils.d.ts.map +1 -1
  10. package/docs/api/README.md +8 -2
  11. package/docs/api/functions/capitalizeString.md +1 -1
  12. package/docs/api/functions/convertJMdict.md +1 -1
  13. package/docs/api/functions/convertJMnedict.md +33 -0
  14. package/docs/api/functions/convertJawiktionaryAsync.md +1 -1
  15. package/docs/api/functions/convertJawiktionarySync.md +1 -1
  16. package/docs/api/functions/convertKanjiDic.md +1 -1
  17. package/docs/api/functions/convertKradFile.md +1 -1
  18. package/docs/api/functions/convertRadkFile.md +1 -1
  19. package/docs/api/functions/convertTanakaCorpus.md +1 -1
  20. package/docs/api/functions/convertTanakaCorpusWithFurigana.md +1 -1
  21. package/docs/api/functions/createEntryMaps.md +9 -3
  22. package/docs/api/functions/generateAnkiNote.md +2 -2
  23. package/docs/api/functions/generateAnkiNotesFile.md +1 -1
  24. package/docs/api/functions/generateFurigana.md +1 -1
  25. package/docs/api/functions/getKanji.md +1 -1
  26. package/docs/api/functions/getKanjiExtended.md +1 -1
  27. package/docs/api/functions/getName.md +57 -0
  28. package/docs/api/functions/getValidForms.md +1 -1
  29. package/docs/api/functions/getWord.md +3 -3
  30. package/docs/api/functions/getWordDefinitions.md +1 -1
  31. package/docs/api/functions/getWordDefinitionsWithFurigana.md +1 -1
  32. package/docs/api/functions/hiraganaToKatakana.md +1 -1
  33. package/docs/api/functions/isObjectArray.md +1 -1
  34. package/docs/api/functions/isStringArray.md +1 -1
  35. package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
  36. package/docs/api/functions/katakanaToHiragana.md +1 -1
  37. package/docs/api/functions/shuffleArray.md +1 -1
  38. package/docs/api/interfaces/DefaultNoteInfo.md +10 -10
  39. package/docs/api/interfaces/Definition.md +4 -4
  40. package/docs/api/interfaces/DictKanji.md +5 -5
  41. package/docs/api/interfaces/DictKanjiForm.md +2 -2
  42. package/docs/api/interfaces/DictKanjiMisc.md +5 -5
  43. package/docs/api/interfaces/DictKanjiReading.md +3 -3
  44. package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
  45. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
  46. package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
  47. package/docs/api/interfaces/DictName.md +75 -0
  48. package/docs/api/interfaces/DictRadical.md +4 -4
  49. package/docs/api/interfaces/DictReading.md +2 -2
  50. package/docs/api/interfaces/EntryMaps.md +33 -9
  51. package/docs/api/interfaces/ExamplePart.md +7 -7
  52. package/docs/api/interfaces/GlossSpecificNumber.md +3 -3
  53. package/docs/api/interfaces/Grammar.md +15 -15
  54. package/docs/api/interfaces/GrammarMeaning.md +3 -3
  55. package/docs/api/interfaces/JaWiktionaryEntry.md +5 -5
  56. package/docs/api/interfaces/Kana.md +11 -11
  57. package/docs/api/interfaces/Kanji.md +23 -23
  58. package/docs/api/interfaces/KanjiComponent.md +3 -3
  59. package/docs/api/interfaces/KanjiForm.md +5 -5
  60. package/docs/api/interfaces/Name.md +163 -0
  61. package/docs/api/interfaces/NeDictMeaning.md +33 -0
  62. package/docs/api/interfaces/NoteAndTag.md +3 -3
  63. package/docs/api/interfaces/NoteHeaderKeys.md +7 -7
  64. package/docs/api/interfaces/Phrase.md +5 -5
  65. package/docs/api/interfaces/Radical.md +16 -16
  66. package/docs/api/interfaces/Reading.md +6 -6
  67. package/docs/api/interfaces/ResultEntry.md +8 -7
  68. package/docs/api/interfaces/TanakaExample.md +7 -7
  69. package/docs/api/interfaces/Translation.md +5 -5
  70. package/docs/api/interfaces/UsefulRegExps.md +8 -8
  71. package/docs/api/interfaces/Word.md +15 -15
  72. package/docs/api/interfaces/WordDefinitionPair.md +4 -4
  73. package/docs/api/type-aliases/Dict.md +1 -1
  74. package/docs/api/type-aliases/{DictName.md → DictNames.md} +3 -3
  75. package/docs/api/type-aliases/EntryExamplesMap.md +13 -0
  76. package/docs/api/type-aliases/EntryType.md +2 -2
  77. package/docs/api/type-aliases/KanjiEntryMap.md +1 -1
  78. package/docs/api/type-aliases/KanjiSVGMap.md +1 -1
  79. package/docs/api/type-aliases/KanjiWordsMap.md +1 -1
  80. package/docs/api/type-aliases/NameIDEntryMap.md +13 -0
  81. package/docs/api/type-aliases/Result.md +2 -2
  82. package/docs/api/type-aliases/WordDefinitionsMap.md +1 -1
  83. package/docs/api/type-aliases/WordIDEntryMap.md +1 -1
  84. package/package.json +8 -7
  85. package/src/types.ts +115 -15
  86. package/src/utils.ts +733 -162
  87. package/docs/api/type-aliases/WordExamplesMap.md +0 -13
package/docs/api/type-aliases/WordExamplesMap.md DELETED
@@ -1,13 +0,0 @@
1
- [**henkan**](../README.md)
2
-
3
- ***
4
-
5
- [henkan](../README.md) / WordExamplesMap
6
-
7
- # Type Alias: WordExamplesMap
8
-
9
- > **WordExamplesMap** = `Map`\<[`StringNumber`](StringNumber.md), [`TanakaExample`](../interfaces/TanakaExample.md)[]\>
10
-
11
- Defined in: [types.ts:459](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L459)
12
-
13
- A `JMdict entry ID` ---> `Tanaka examples associated with the JMdict entry` map