sudachi-synonyms-dictionary-kurai-forked-ver
Version:
sudachi's synonyms dictionary
74 lines (71 loc) • 3.84 kB
TypeScript
export declare type SudachiSynonymsGroup = {
/**
* 0 : グループ番号
* 同義語として登録する見出しには、共通のグループ番号を付与します。 この番号は、ソース内で同義語の管理・識別に使用するため、一度発行したグループ番号は変更しません。 グループ番号は6桁の数字で表します。
*/
id: string;
items: SudachiSynonyms[];
};
export declare type SudachiSynonyms = {
/**
* 1 : 体言/用言フラグ
* 見出しが体言か用言かを管理・識別する情報です。省略された場合は"未定義"になります。
*/
taigenYogen: "体言" | "用言" | "未定義";
/**
* 2 : 展開制御フラグ
* 同義語展開をする・しないを制御する情報です。省略することもできます。
* 省略した場合は、「0 : 常に展開に使用する」と同じ扱いになります。
* 0 : 常に展開に使用する
* 1 : 自分自身が展開のトリガーとはならないが、同グループ内の別の見出しからは展開される
* 2 : 常に展開に使用しない ※削除履歴として利用 (弊害語などが誤って再登録されるのを防ぐため)
*/
expandControl: 0 | 1 | 2;
/**
* 3 : グループ内の語彙番号
* グループ内における、同一語彙の管理番号です。省略することもできます。 "1"始まりで連番を付与します。
* 「異表記や、外来語の表記ゆれ、原語綴り、対訳、略語、略称、別称 (通称・愛称、等) 、旧称、間違い」は、表記や語形が異なるだけで、同じ語彙と見なします。
*/
vocabularyNumber: number | undefined;
/**
* 4 : 同一語彙内での語形種別
* 同一語彙内 (3の番号が同じもの) における語形の関連性を示す情報です。省略することもできます。
* 0 : 代表語
* 1 : (代表語から見て) 対訳
* 2 : (代表語から見て) 別称 (通称・愛称等)
* 3 : (代表語から見て) 旧称
* 4 : (代表語から見て) 間違い
*/
gokeiSyubetsu: "代表語" | "対訳" | "別称" | "旧称" | "間違い" | "未定義";
/**
* 5 : 同じ語形の語の中での略語・略称情報
* 同じ語形の語 (3、4の番号が同じもの) における、略語・略称の関係を示す情報です。省略された場合は"未定義"になります。
* 0 : 代表語形
* 1 : (代表語形から見て) 略語・略称 (アルファベット表記)
* 2 : (代表語形から見て) 略語・略称 (1以外)
*/
ryakusyou: "代表語形" | "略語・略称/アルファベット" | "略語・略称" | "未定義";
/**
* 6 : 同じ語形の語の中での表記揺れ情報
* 同じ語形の語 (3、4、5の番号が同じもの) における、表記の関連性を示す情報です。省略された場合は"未定義"になります。
*/
hyoukiYure: "代表表記" | "アルファベット表記" | "異表記・表記ゆれ" | "間違い表記" | "未定義";
/**
* 7 : 分野情報
* 見出しが、どういう分野の語句であるかを示す情報です。省略することもできます。
* 省略した場合は空の配列になります
*/
bunya: string[];
/**
* 8 : 見出し
* 同義語辞書に登録される語句です。
*/
midashi: string;
};
export interface fetchDictionaryOptions {
url: string;
}
/**
* Fetch dictionary and return a Promise that resolve with dictionary object.
*/
export declare function fetchDictionary(options?: fetchDictionaryOptions): Promise<readonly SudachiSynonymsGroup[]>;