• 한국어 (한글)
    • Rust
    JSR

      렌더링 모드

      한자와 그 한글 독음이 출력에 어떻게 나타날지 제어하려면 load의 rendering 옵션을 설정합니다.

      사용 가능한 모드

      값입력출력
      "hangul-only" (기본)한자한자
      "hangul-hanja-parens"한자한자(한자)
      "hanja-hangul-parens"한자한자(한자)
      "ruby-on-hangul"한자<ruby>한자<rp>(</rp><rt>漢字</rt><rp>)</rp></ruby>
      "ruby-on-hanja"한자<ruby>漢字<rp>(</rp><rt>한자</rt><rp>)</rp></ruby>
      "original"한자한자 (필요한 곳에 병기 추가)
      import { 
      function load(options?: GukhanmunOptions): Promise<Gukhanmun>
      Creates a Gukhanmun converter with the given options.
      

      Initialises the WASM module on the first call (subsequent calls reuse the
cached module).  Dictionaries supplied via
 
GukhanmunOptions.dictionaries
  are fetched and passed to the Rust
engine as FileDictionarySource values.
      

      Note: unlike the Rust ko-kr preset, the JavaScript preset never includes a
bundled dictionary.  Pass dictionaries: [await stdictFst()] to include the
Standard Korean Language Dictionary.
      @paramoptions  - Conversion options.  All fields are optional; defaults match
the ko-kr preset.@returnsA  Gukhanmun instance.@throws{@linkGukhanmunError } on invalid options or dictionary load failure.
      load       } from "@gukhanmun/wasm";      
import { 
      function stdictFst(): Promise<FileDictionarySource>
      Loads the bundled Standard Korean Language Dictionary as a
      

      FileDictionarySource
ready to pass to load({ dictionaries: [...] }).
      @returnsA  FileDictionarySource with format: "fst".
      stdictFst       } from "@gukhanmun/stdict-fst";      

const 
      const g: Gukhanmun
      g       = await 
      function load(options?: GukhanmunOptions): Promise<Gukhanmun>
      Creates a Gukhanmun converter with the given options.
      

      Initialises the WASM module on the first call (subsequent calls reuse the
cached module).  Dictionaries supplied via
 
GukhanmunOptions.dictionaries
  are fetched and passed to the Rust
engine as FileDictionarySource values.
      

      Note: unlike the Rust ko-kr preset, the JavaScript preset never includes a
bundled dictionary.  Pass dictionaries: [await stdictFst()] to include the
Standard Korean Language Dictionary.
      @paramoptions  - Conversion options.  All fields are optional; defaults match
the ko-kr preset.@returnsA  Gukhanmun instance.@throws{@linkGukhanmunError } on invalid options or dictionary load failure.
      load      ({      
  
      GukhanmunOptions.rendering?: RenderMode | undefined
      How annotations are rendered into output text or markup.  Defaults to
"hangul-only".
      @seeRenderMode
      rendering      : "hangul-hanja-parens",      
  
      GukhanmunOptions.dictionaries?: readonly FileDictionarySource[] | undefined
      Ordered list of dictionary sources.  Sources are queried in order;
earlier entries take precedence.  When omitted (or empty), only the
fallback Unihan character map is used (no stdict).
      

      Unlike the "ko-kr" Rust preset, JavaScript presets do not
automatically include a bundled dictionary.  To use the Standard Korean
Language Dictionary, add @gukhanmun/stdict-fst or
@gukhanmun/stdict-cdb explicitly.
      @seeDictionarySource
      dictionaries      : [await 
      function stdictFst(): Promise<FileDictionarySource>
      Loads the bundled Standard Korean Language Dictionary as a
      

      FileDictionarySource
ready to pass to load({ dictionaries: [...] }).
      @returnsA  FileDictionarySource with format: "fst".
      stdictFst      ()],      
});


      var console: Console
      The console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
      

      The module exports two specific components:
      

        

      • A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
        • 

      • A global console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.
        • 

      

      Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
      

      Example using the global console:
      

      console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
//   Error: Whoops, something bad happened
//     at [eval]:5:15
//     at Script.runInThisContext (node:vm:132:18)
//     at Object.runInThisContext (node:vm:309:38)
//     at node:internal/process/execution:77:19
//     at [eval]-wrapper:6:22
//     at evalScript (node:internal/process/execution:76:60)
//     at node:internal/main/eval_string:23:3

const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
      

      Example using the Console class:
      

      const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);

myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err
      @seesource
      console      .
      Console.log(message?: any, ...optionalParams: any[]): void (+1 overload)
      Prints to stdout with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
      

      const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout
      

      See util.format() for more information.
      @sincev0 .1.100
      log      (
      const g: Gukhanmun
      g      .
      Gukhanmun.convert(source: string, format?: Format): string
      Converts source to hangul in one shot.  Buffers the entire input
before returning.
      @paramsource  - The text to convert.@paramformat  - Input / output format.  Defaults to "text".@returnsThe  converted text.@throws{@linkGukhanmunError } on conversion failure.
      convert      ("漢字"));  // 한자(漢字)

      루비 마크업

      "ruby-on-hangul"과 "ruby-on-hanja"는 <ruby> 요소를 만듭니다. "html"이나 "markdown" 형식과 함께 사용합니다; 순수 텍스트에서는 괄호로 퇴화합니다. 주석은 <rp>(ruby parenthesis) 요소로 감싸지므로, <ruby>를 지원하지 않는 브라우저도 독음을 기저 텍스트에 섞지 않고 괄호로 묶인 병기(한자(漢字))로 보입니다:

      const 
      const g: Gukhanmun
      g       = await 
      function load(options?: GukhanmunOptions): Promise<Gukhanmun>
      Creates a Gukhanmun converter with the given options.
      

      Initialises the WASM module on the first call (subsequent calls reuse the
cached module).  Dictionaries supplied via
 
GukhanmunOptions.dictionaries
  are fetched and passed to the Rust
engine as FileDictionarySource values.
      

      Note: unlike the Rust ko-kr preset, the JavaScript preset never includes a
bundled dictionary.  Pass dictionaries: [await stdictFst()] to include the
Standard Korean Language Dictionary.
      @paramoptions  - Conversion options.  All fields are optional; defaults match
the ko-kr preset.@returnsA  Gukhanmun instance.@throws{@linkGukhanmunError } on invalid options or dictionary load failure.
      load      ({      
  
      GukhanmunOptions.rendering?: RenderMode | undefined
      How annotations are rendered into output text or markup.  Defaults to
"hangul-only".
      @seeRenderMode
      rendering      : "ruby-on-hangul",      
  
      GukhanmunOptions.dictionaries?: readonly FileDictionarySource[] | undefined
      Ordered list of dictionary sources.  Sources are queried in order;
earlier entries take precedence.  When omitted (or empty), only the
fallback Unihan character map is used (no stdict).
      

      Unlike the "ko-kr" Rust preset, JavaScript presets do not
automatically include a bundled dictionary.  To use the Standard Korean
Language Dictionary, add @gukhanmun/stdict-fst or
@gukhanmun/stdict-cdb explicitly.
      @seeDictionarySource
      dictionaries      : [await 
      function stdictFst(): Promise<FileDictionarySource>
      Loads the bundled Standard Korean Language Dictionary as a
      

      FileDictionarySource
ready to pass to load({ dictionaries: [...] }).
      @returnsA  FileDictionarySource with format: "fst".
      stdictFst      ()],      
});


      var console: Console
      The console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
      

      The module exports two specific components:
      

        

      • A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
        • 

      • A global console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.
        • 

      

      Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
      

      Example using the global console:
      

      console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
//   Error: Whoops, something bad happened
//     at [eval]:5:15
//     at Script.runInThisContext (node:vm:132:18)
//     at Object.runInThisContext (node:vm:309:38)
//     at node:internal/process/execution:77:19
//     at [eval]-wrapper:6:22
//     at evalScript (node:internal/process/execution:76:60)
//     at node:internal/main/eval_string:23:3

const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
      

      Example using the Console class:
      

      const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);

myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err
      @seesource
      console      .
      Console.log(message?: any, ...optionalParams: any[]): void (+1 overload)
      Prints to stdout with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
      

      const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout
      

      See util.format() for more information.
      @sincev0 .1.100
      log      (
      const g: Gukhanmun
      g      .
      Gukhanmun.convert(source: string, format?: Format): string
      Converts source to hangul in one shot.  Buffers the entire input
before returning.
      @paramsource  - The text to convert.@paramformat  - Input / output format.  Defaults to "text".@returnsThe  converted text.@throws{@linkGukhanmunError } on conversion failure.
      convert      ("<p>漢字</p>", "html"));      
// → <p><ruby>한자<rp>(</rp><rt>漢字</rt><rp>)</rp></ruby></p>

      병기를 곁들인 Original 모드

      구별이 필요한 곳에만 병기를 더하려면 "original"을 originalGloss와 함께 사용합니다:

      const 
      const g: Gukhanmun
      g       = await 
      function load(options?: GukhanmunOptions): Promise<Gukhanmun>
      Creates a Gukhanmun converter with the given options.
      

      Initialises the WASM module on the first call (subsequent calls reuse the
cached module).  Dictionaries supplied via
 
GukhanmunOptions.dictionaries
  are fetched and passed to the Rust
engine as FileDictionarySource values.
      

      Note: unlike the Rust ko-kr preset, the JavaScript preset never includes a
bundled dictionary.  Pass dictionaries: [await stdictFst()] to include the
Standard Korean Language Dictionary.
      @paramoptions  - Conversion options.  All fields are optional; defaults match
the ko-kr preset.@returnsA  Gukhanmun instance.@throws{@linkGukhanmunError } on invalid options or dictionary load failure.
      load      ({      
  
      GukhanmunOptions.rendering?: RenderMode | undefined
      How annotations are rendered into output text or markup.  Defaults to
"hangul-only".
      @seeRenderMode
      rendering      : "original",      
  
      GukhanmunOptions.originalGloss?: OriginalGloss | undefined
      How glosses are rendered when rendering is "original".  Ignored for
all other render modes.  Defaults to "parens".
      @seeOriginalGloss
      originalGloss      : "parens",  // 또는 "ruby"      
  
      GukhanmunOptions.dictionaries?: readonly FileDictionarySource[] | undefined
      Ordered list of dictionary sources.  Sources are queried in order;
earlier entries take precedence.  When omitted (or empty), only the
fallback Unihan character map is used (no stdict).
      

      Unlike the "ko-kr" Rust preset, JavaScript presets do not
automatically include a bundled dictionary.  To use the Standard Korean
Language Dictionary, add @gukhanmun/stdict-fst or
@gukhanmun/stdict-cdb explicitly.
      @seeDictionarySource
      dictionaries      : [await 
      function stdictFst(): Promise<FileDictionarySource>
      Loads the bundled Standard Korean Language Dictionary as a
      

      FileDictionarySource
ready to pass to load({ dictionaries: [...] }).
      @returnsA  FileDictionarySource with format: "fst".
      stdictFst      ()],      
});


      var console: Console
      The console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
      

      The module exports two specific components:
      

        

      • A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
        • 

      • A global console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.
        • 

      

      Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
      

      Example using the global console:
      

      console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
//   Error: Whoops, something bad happened
//     at [eval]:5:15
//     at Script.runInThisContext (node:vm:132:18)
//     at Object.runInThisContext (node:vm:309:38)
//     at node:internal/process/execution:77:19
//     at [eval]-wrapper:6:22
//     at evalScript (node:internal/process/execution:76:60)
//     at node:internal/main/eval_string:23:3

const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
      

      Example using the Console class:
      

      const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);

myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err
      @seesource
      console      .
      Console.log(message?: any, ...optionalParams: any[]): void (+1 overload)
      Prints to stdout with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
      

      const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout
      

      See util.format() for more information.
      @sincev0 .1.100
      log      (
      const g: Gukhanmun
      g      .
      Gukhanmun.convert(source: string, format?: Format): string
      Converts source to hangul in one shot.  Buffers the entire input
before returning.
      @paramsource  - The text to convert.@paramformat  - Input / output format.  Defaults to "text".@returnsThe  converted text.@throws{@linkGukhanmunError } on conversion failure.
      convert      ("東京에서 東洋까지"));      
// 同音異義語 倂記됨: 東京(동경)에서 東洋(동양)까지