@gukhanmun/types 0.1.0-dev.0 → 0.1.0-dev.12
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.
- package/README.md +43 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
@gukhanmun/types
|
|
2
|
+
================
|
|
3
|
+
|
|
4
|
+
TypeScript type declarations for the Gukhanmun JavaScript API. This package
|
|
5
|
+
carries no runtime code; it exists so that both `@gukhanmun/wasm` and
|
|
6
|
+
`@gukhanmun/napi` can share the same type definitions without duplicating them.
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
Installation
|
|
10
|
+
------------
|
|
11
|
+
|
|
12
|
+
~~~~ sh
|
|
13
|
+
npm install @gukhanmun/types
|
|
14
|
+
~~~~
|
|
15
|
+
|
|
16
|
+
This package is listed as a peer dependency of `@gukhanmun/wasm` and
|
|
17
|
+
`@gukhanmun/napi`, so it is usually installed transitively.
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
What is declared here
|
|
21
|
+
---------------------
|
|
22
|
+
|
|
23
|
+
`Preset` (`"ko-kr"` | `"ko-kp"`) and `RenderMode` control orthographic
|
|
24
|
+
conventions and output format. `GukhanmunOptions` is the options bag passed to
|
|
25
|
+
`load()`; it covers preset, rendering, segmentation, numerals, initial sound
|
|
26
|
+
law, homophone window, first-occurrence window, recovery, directives, and HTML
|
|
27
|
+
options. `Gukhanmun` is the converter interface returned by `load()`, with
|
|
28
|
+
`convert()` and `convertStream()` methods. `GukhanmunError` is the structured
|
|
29
|
+
error class with a typed `code` property and a `chain` array of causes.
|
|
30
|
+
|
|
31
|
+
`DictionarySource` describes how to supply a dictionary: as a
|
|
32
|
+
`{ format, bytes }` record pointing to already-loaded binary data. `Format` is
|
|
33
|
+
the input format selector: `"text/plain"`, `"text/html"`, `"text/markdown"`, or
|
|
34
|
+
a `{ format: "text/markdown", gfm: boolean }` object.
|
|
35
|
+
|
|
36
|
+
All TSDoc comments live in this package as the single source of truth for the
|
|
37
|
+
JavaScript API. Refer to the declarations in `index.ts` for the full details.
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
License
|
|
41
|
+
-------
|
|
42
|
+
|
|
43
|
+
GPL-3.0-only.
|