Package Exports

kuroshiro-analyzer-mecab

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (kuroshiro-analyzer-mecab) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

kuroshiro-analyzer-mecab

Package	kuroshiro-analyzer-mecab
Description	mecab morphological analyzer for kuroshiro.
Compatibility	Node	✓ (>=6)
	Browser	✗

Pre-requisite

You should have mecab and corresponding dictionary installed in your environment. And make sure that your have added mecab command to your $PATH environment variable. This analyzer will invoke mecab from command line when parsing.

For install instructions of mecab, you could check the official website of mecab from here.

Install

$ npm install kuroshiro-analyzer-mecab

Usage with kuroshiro

Configure analyzer

This analyzer utilizes mecab morphological analyzer.

The mecab-ipadic-neologd dictionary is recommanded which includes many neologisms (new word) and periodically updated.

import MecabAnalyzer from "kuroshiro-analyzer-mecab";

const analyzer = new MecabAnalyzer();

await kuroshiro.init(analyzer);

Initialization Parameters

Example:

const analyzer = new MecabAnalyzer({
    dictPath: "/usr/lib/mecab/dic/mecab-ipadic-neologd/",
    execOptions: {
        maxBuffer: 200 * 1024,
        timeout: 0
    }
});

command: Optional mecab command (may have arguments). If set, the param dictPath is ignored
dictPath: Optional Path of the dictionary mecab used
execOptions: Optional The exec options to run mecab command. Example as below:

{
    // Largest amount of data in bytes allowed on stdout or stderr. see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback.
    maxBuffer: 200 * 1024,

    // Timeout. see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback.
    timeout: 0
}