Skip to content

API Documentation

Classes

韻鏡位置

Defined in: core/韻鏡位置.ts:28

韻鏡中的一個格位。

包含 (轉號, 上位, 右位) 三要素。可使用該三要素初始化。

  • 轉號:轉的序號(1–43)。
  • 上位:在一個轉中,從上向下數的位置(1–16)。
  • 右位:在一個轉中,從右向左數的位置(1–23)。

Constructors

Constructor
ts
new 韻鏡位置(
   轉號, 
   上位, 
   右位): 韻鏡位置;

Defined in: core/韻鏡位置.ts:43

建立一個韻鏡位置。

Parameters
轉號

number

上位

number

右位

number

Returns

韻鏡位置

Throws

若任何取值超出韻鏡範圍

Properties

上位
ts
上位: number;

Defined in: core/韻鏡位置.ts:33

在一個轉中,從上向下數的位置(1–16)。

右位
ts
右位: number;

Defined in: core/韻鏡位置.ts:36

在一個轉中,從右向左數的位置(1–23)。

轉號
ts
轉號: number;

Defined in: core/韻鏡位置.ts:30

轉的序號(1–43)。

Accessors

切韻等
Get Signature
ts
get 切韻等(): string;

Defined in: core/韻鏡位置.ts:104

切韻等(「一二三四」)。

Returns

string

Get Signature
ts
get (): string | null;

Defined in: core/韻鏡位置.ts:227

韻鏡呼(開/合/null)。

幫滂並明母、模侯尤韻的呼均為 null

與《韻鏡》標註的呼未必一致,例如包含 null,又如《韻鏡》原書第四轉標註為「內轉第四開合」,而此處為「開」。

Returns

string | null

坐標
Get Signature
ts
get 坐標(): string;

Defined in: core/韻鏡位置.ts:70

坐標的字串表示(如「(1,1,1)」)。

Returns

string

描述
Get Signature
ts
get 描述(): string;

Defined in: core/韻鏡位置.ts:302

韻鏡位置描述(如「外轉第四十二圖·舌音第一位·入聲位·韻鏡一等」)。

Returns

string

Get Signature
ts
get (): string;

Defined in: core/韻鏡位置.ts:141

韻鏡母。

Returns

string

Get Signature
ts
get (): string;

Defined in: core/韻鏡位置.ts:245

聲調。

由上位推得,並根據「去聲寄此」的韻鏡標註修正。

Returns

string

轉名稱
Get Signature
ts
get 轉名稱(): string;

Defined in: core/韻鏡位置.ts:62

轉的名稱(如「內轉第一圖」)。

Returns

string

Get Signature
ts
get (): 
  | "東"
  | "冬"
  | "鍾"
  | "江"
  | "支"
  | "脂"
  | "之"
  | "廢"
  | "微"
  | "魚"
  | "模"
  | "虞"
  | "夬"
  | "咍"
  | "皆"
  | "齊"
  | "祭"
  | "灰"
  | "佳"
  | "泰"
  | "痕"
  | "真"
  | "臻"
  | "魂"
  | "殷"
  | "文"
  | "元"
  | "仙"
  | "刪"
  | "山"
  | "寒"
  | "先"
  | "豪"
  | "肴"
  | "宵"
  | "蕭"
  | "歌"
  | "麻"
  | "唐"
  | "陽"
  | "庚"
  | "清"
  | "耕"
  | "青"
  | "侯"
  | "尤"
  | "幽"
  | "侵"
  | "覃"
  | "咸"
  | "鹽"
  | "添"
  | "談"
  | "銜"
  | "嚴"
  | "凡"
  | "登"
  | "蒸";

Defined in: core/韻鏡位置.ts:95

韻鏡韻。

與切韻的韻未必一致。

與《韻鏡》標註的韻亦未必一致,因為存在一些特殊情況,例如《韻鏡》原書存在刪、山韻排反的情況,此處均已進行修正。

Returns

| "東" | "冬" | "鍾" | "江" | "支" | "脂" | "之" | "廢" | "微" | "魚" | "模" | "虞" | "夬" | "咍" | "皆" | "齊" | "祭" | "灰" | "佳" | "泰" | "痕" | "真" | "臻" | "魂" | "殷" | "文" | "元" | "仙" | "刪" | "山" | "寒" | "先" | "豪" | "肴" | "宵" | "蕭" | "歌" | "麻" | "唐" | "陽" | "庚" | "清" | "耕" | "青" | "侯" | "尤" | "幽" | "侵" | "覃" | "咸" | "鹽" | "添" | "談" | "銜" | "嚴" | "凡" | "登" | "蒸"

韻鏡等
Get Signature
ts
get 韻鏡等(): number;

Defined in: core/韻鏡位置.ts:81

韻鏡等(「一二三四」)。

僅由上位決定,與切韻等未必一致。

Returns

number

Get Signature
ts
get (): "B" | "A" | "C" | null;

Defined in: core/韻鏡位置.ts:260

切韻類(A/B/C/null)。

Returns

"B" | "A" | "C" | null

Methods

to音韻地位()
ts
to音韻地位(): 音韻地位;

Defined in: core/韻鏡位置.ts:312

轉換為切韻音系音韻地位物件。

Returns

音韻地位

等於()
ts
等於(other): boolean;

Defined in: core/韻鏡位置.ts:321

判定兩個韻鏡位置是否完全相同。

Parameters
other

韻鏡位置

Returns

boolean

Variables

VERSION

ts
const VERSION: "0.1.2" = '0.1.2';

Defined in: index.ts:7

Functions

iter韻鏡字頭()

ts
function iter韻鏡字頭(): Generator<{
  字頭: string;
  韻鏡位置: 韻鏡位置;
}, void, unknown>;

Defined in: core/韻鏡字頭.ts:7

迭代《韻鏡》所有字頭及其對應的韻鏡位置。

Returns

Generator<{ 字頭: string; 韻鏡位置: 韻鏡位置; }, void, unknown>


音韻地位2韻鏡位置()

ts
function 音韻地位2韻鏡位置(當前音韻地位): 韻鏡位置;

Defined in: core/音韻地位2韻鏡位置.ts:9

將切韻音系音韻地位轉換為韻鏡位置物件。

Parameters

當前音韻地位

音韻地位

Returns

韻鏡位置


韻鏡位置2字頭()

ts
function 韻鏡位置2字頭(當前韻鏡位置): string | undefined;

Defined in: core/韻鏡字頭.ts:30

根據韻鏡位置取得字頭。若無對應字頭,則回傳 undefined

Parameters

當前韻鏡位置

韻鏡位置

Returns

string | undefined