設定とプラグイン^2.3.0 ​

iztroの設定とプラグイン機能を紹介します。紫微斗数には多くの流派があり、四化や星曜の輝度に少しずつ違いがあります。こうした違いに対応し、機能を拡張できるように、iztroはv2.3.0でグローバル設定と外部プラグインの機能を導入しました。

設定 ​

設定項目は設定の定義を参照してください。グローバル設定は、命盤を作成するメソッドの呼び出し前にastro.config()を呼び出すだけです。

import { astro } from 'iztro';

astro.config({
  mutagens: { 庚: ['太阳', '武曲', '天同', '天相'] },
  brightness: {
    贪狼: ['旺', '旺', '旺', '旺', '旺', '旺', '旺', '旺', '旺', '旺', '旺', '旺'],
  },
});

上記のコードを実行してから命盤を作成すると、指定した設定が既定の設定と統合されて適用されます。既定値と同じ項目を改めて指定する必要はありません。四化の既定値は十天干四化表、星曜の輝度の既定値は星曜輝度表を参照してください。

mutagensとbrightnessのほか、次のオプションで命盤計算の規則を調整できます。

getConfig() ^2.3.0 ​

• 目的

  現在有効なグローバル設定を取得します。戻り値の mutagens と brightness には、ライブラリ内部で統一されたキー名が使われます。デバッグや設定内容の確認に利用できます。

  ^2.6.2 戻り値は独立したディープコピーです。オブジェクトや、その中の四化・輝度の配列を変更しても、ライブラリの設定は変わりません。

• 定義

  ts

  type getConfig = () => {
    mutagens: Partial<Record<HeavenlyStemKey, StarKey[]>>;
    brightness: Partial<Record<StarKey, BrightnessKey[]>>;
    yearDivide: 'normal' | 'exact';
    ageDivide: 'normal' | 'birthday';
    dayDivide: 'current' | 'forward';
    horoscopeDivide: 'normal' | 'exact';
    algorithm: 'default' | 'zhongzhou';
  };

• パラメータ

  なし

• 戻り値

  現在有効な設定オブジェクト

• 例

  ts

  import { astro } from 'iztro';
  
  astro.config({ algorithm: 'zhongzhou', ageDivide: 'birthday' });
  
  const currentConfig = astro.getConfig();

resetConfig() ^2.6.2 ​

既定の設定に戻し、独自に設定した四化表と輝度表をすべて消去します。作成済みの命盤には影響しません。

type resetConfig = () => void;

既定の区切り規則はyearDivide: 'normal'、horoscopeDivide: 'normal'、ageDivide: 'normal'、dayDivide: 'forward'で、星曜の配置方法はalgorithm: 'default'です。このメソッドには引数も戻り値もありません。読み込み済みのプラグインはリセットしません。

const chart = astro.withOptions({
  dateStr: '2000-8-16',
  timeIndex: 3,
  gender: '男',
  config: { ageDivide: 'birthday' },
});
astro.resetConfig();
chart.horoscope('2026-3-1'); // 仍使用该星盘生成时的生日分界配置

プラグイン ​

iztroのプラグインは、命盤オブジェクトに機能を追加する関数です。必要に応じて機能を拡張できます。TypeScriptで開発する場合は、FunctionalAstrolabeを継承するインターフェイスにプラグインのメソッドを宣言してください。

インターフェイスは次のように宣言されます。

export interface IAstrolabe extends FunctionalAstrolabe {
  myNewFunc: () => string;
  majorStar: () => string;
}

myNewFuncとmajorStarは必要に応じて定義できます。インターフェイスのメソッドは、1つのプラグイン関数にまとめて実装しても、複数のプラグイン関数に分けて実装してもかまいません。

// 创建一个插件函数
export function myTestPlugin(this: IAstrolabe): void {
  // 实现插件应用逻辑
  this.myNewFunc = () => {
    return this.fiveElementsClass;
  };
}

// 创建二个插件函数
export function myTestPlugin2(this: IAstrolabe): void {
  // 实现插件应用逻辑
  this.majorStar = () => {
    let stars = this.palace('命宫')
      ?.majorStars.filter((item) => item.type === 'major' && !['禄存', '天马'].includes(item.name))
      .map((item) => item.name)
      .join(',');

    if (!stars) {
      stars = this.palace('迁移')
        ?.majorStars.filter((item) => item.type === 'major' && !['禄存', '天马'].includes(item.name))
        .map((item) => item.name)
        .join(',');
    }

    return stars ?? '';
  };
}

プラグインを登録するには、astroをインポートした後にloadPlugin()またはloadPlugins()を呼び出します。どちらで登録しても、プラグインはその後新しく作成する命盤のインスタンスに適用されます。

import {astro} from iztro;

// 批量挂载插件
astro.loadPlugins([myTestPlugin， myTestPlugin2]);

// 逐个加载插件
astro.loadPlugin(myTestPlugin);
astro.loadPlugin(myTestPlugin2);

作成済みの特定の命盤だけにプラグインを適用するには、その命盤のインスタンスのuse()メソッドを呼び出します。

const astrolabe = astro.bySolar<IAstrolabe>('2023-10-18', 4, 'female');

astrolabe.use(myTestPlugin);
astrolabe.myNewFunc();

const astrolabe = astro.bySolar<IAstrolabe>('2023-10-18', 4, 'female');

 // 使用插件定义的方法
 astrolabe.myNewFunc();   // 火六局

 // 使用第二个插件方法
 astrolabe.majorStar();   // 七杀