iztro/lib/data/types/astro.d.ts

轻量级紫微斗数星盘生成库。可以通过出生年月日获取到紫微斗数星盘信息、生肖、星座等信息。This is a lightweight kit for generating astrolabes for Zi Wei Dou Shu (The Purple Star Astrology), an ancient Chinese astrology. It allows you to obtain your horoscope and personality analysis.

import { IFunctionalPalace } from '../../astro/FunctionalPalace';
import { Brightness, EarthlyBranchName, FiveElementsClassName, GenderName, HeavenlyStemName, PalaceName, StarName } from '../../i18n';
import FunctionalStar from '../../star/FunctionalStar';
import { HeavenlyStemAndEarthlyBranchDate, LunarDate } from 'lunar-lite/lib/types';
import { Language } from './general';
/**
 * 运限对象
 *
 * @property
 * - index 所在宫位的索引
 * - heavenlyStem 该运限天干
 * - palaceNames 该运限的十二宫
 * - mutagen 四化星
 * - stars 流耀
 */
export type HoroscopeItem = {
    /** 所在宫位的索引 */
    index: number;
    /** 运限名称 */
    name: string;
    /** 该运限天干 */
    heavenlyStem: HeavenlyStemName;
    /** 该运限地支 */
    earthlyBranch: EarthlyBranchName;
    /** 该运限的十二宫 */
    palaceNames: PalaceName[];
    /** 四化星 */
    mutagen: StarName[];
    /** 流耀 */
    stars?: FunctionalStar[][];
};
/**
 * 大限
 *
 * @property
 * - range 大限起止年龄 [起始年龄, 截止年龄]
 * - heavenlyStem 大限天干
 * - earthlyBranch 大限地支
 */
export type Decadal = {
    /** 大限起止年龄 [起始年龄, 截止年龄] */
    range: [number, number];
    /** 大限天干 */
    heavenlyStem: HeavenlyStemName;
    /** 大限地支 */
    earthlyBranch: EarthlyBranchName;
};
/**
 * 运限
 *
 * @property
 * - lunarDate 农历日期
 * - solarDate 阳历日期
 * - decadal 大限
 * - age 小限
 * - yearly 流年
 * - monthly 流月
 * - daily 流日
 */
export type Horoscope = {
    /** 农历日期 */
    lunarDate: string;
    /** 阳历日期 */
    solarDate: string;
    /** 大限 */
    decadal: HoroscopeItem;
    /**
     * 小限
     *
     * @property
     * - nominalAge 虚岁
     */
    age: HoroscopeItem & {
        /** 虚岁 */
        nominalAge: number;
    };
    /** 流年 */
    yearly: HoroscopeItem & {
        yearlyDecStar: {
            jiangqian12: StarName[];
            suiqian12: StarName[];
        };
    };
    /** 流月 */
    monthly: HoroscopeItem;
    /** 流日 */
    daily: HoroscopeItem;
    /** 流时 */
    hourly: HoroscopeItem;
};
/**
 * 星盘对象
 *
 * @property
 * - solarDate 阳历日期
 * - lunarDate 农历日期
 * - chineseDate 干支纪年日期
 * - time 时辰
 * - timeRange 时辰对应的时间段
 * - sign 星座
 * - zodiac 生肖
 * - earthlyBranchOfSoulPalace 命宫地支
 * - earthlyBranchOfBodyPalace 身宫地支
 * - soul 命主
 * - body 身主
 * - palaces 十二宫数据
 *
 * @function
 * - horoscope() 获取运限数据
 * - palace() 获取宫位数据
 */
export type Astrolabe = {
    /** 性别 */
    gender: string;
    /** 阳历日期 */
    solarDate: string;
    /** 农历日期 */
    lunarDate: string;
    /** 干支纪年日期 */
    chineseDate: string;
    /**
     * 原始日期数据，用于今后内部方法使用
     *
     * @property
     * - lunar 农历日期对象
     * - chinese 干支纪年日期对象
     */
    rawDates: {
        /** 农历日期对象 */
        lunarDate: LunarDate;
        /** 干支纪年日期对象 */
        chineseDate: HeavenlyStemAndEarthlyBranchDate;
    };
    /** 时辰 */
    time: string;
    /** 时辰对应的时间段 */
    timeRange: string;
    /** 星座 */
    sign: string;
    /** 生肖 */
    zodiac: string;
    /** 命宫地支 */
    earthlyBranchOfSoulPalace: EarthlyBranchName;
    /** 身宫地支 */
    earthlyBranchOfBodyPalace: EarthlyBranchName;
    /** 命主 */
    soul: StarName;
    /** 身主 */
    body: StarName;
    /** 五行局 */
    fiveElementsClass: FiveElementsClassName;
    /** 十二宫数据 */
    palaces: IFunctionalPalace[];
    /** 版权 */
    copyright: string;
};
/**
 * 定义一个接口，表示插件函数的类型
 * */
export type Plugin = () => void;
export type ConfigMutagens = Partial<Record<HeavenlyStemName, StarName[]>>;
export type ConfigBrightness = Partial<Record<StarName, Brightness[]>>;
export type AstroType = 'heaven' | 'earth' | 'human';
export type Config = {
    /** 四化配置 */
    mutagens?: ConfigMutagens;
    /** 星耀亮度配置 */
    brightness?: ConfigBrightness;
    /** 年分割点配置，normal为正月初一分界，exact为立春分割 */
    yearDivide?: 'normal' | 'exact';
    /** 运限分割点配置，normal为正月初一分界，exact为立春分割 */
    horoscopeDivide?: 'normal' | 'exact';
    /** 小限分割点配置，normal为以自然年分界，birthday为生日分界 */
    ageDivide?: 'normal' | 'birthday';
    /** 晚子时配置，current时晚子时算当日，forward时晚子时算来日 */
    dayDivide?: 'current' | 'forward';
    /** 安星方法，default为通行版本，zhongzhou为中州派版本 */
    algorithm?: 'default' | 'zhongzhou';
};
/**
 * 排盘参数，该对象用于获取紫微斗数星盘数据。
 */
export type Option = {
    /** 日期类型。
     * - 阳历：'solar'
     * - 阴历：'lunar'
     */
    type: 'solar' | 'lunar';
    /** 阳历日期，格式为YYYY-MM-DD */
    dateStr: string;
    /** 时辰索引。0为早子时，1为丑时，以此类推，12为晚子时 */
    timeIndex: number;
    /** 性别。支持多语言输入，比如可以输入 `男` 或 `女`，也可以输入 `male` 或 `femal` */
    gender: GenderName;
    /** 是否为闰月。仅阴历类型是可用，当月没有闰月时不生效。 */
    isLeapMonth?: boolean;
    /** 是否修正闰月。当修正闰月时，以农历15日为界，15日（含）之前算当月，之后算下月。 */
    fixLeap?: boolean;
    /** 输出语言。支持 'en-US', 'ja-JP', 'ko-KR', 'zh-CN', 'zh-TW', 'vi-VN' */
    language?: Language;
    /** 配置项。 */
    config?: Config;
    /**
     * 星盘类型（中州派特有）。默认为天盘。
     * - 天盘：'heaven'
     * - 地盘：'earth'
     * - 人盘：'human'
     */
    astroType?: AstroType;
};
/**
 * 通用排盘参数，该参数类型主要用于需要传递完整生辰和五行局起始干支的场景。
 * 五行局起始干支主要用于中州派的地盘、人盘排法。
 */
export type AstrolabeParam = {
    /** 阳历日期，格式为YYYY-MM-DD */
    solarDate: string;
    /** 时辰索引【0～12】，0为早子时，12为晚子时 */
    timeIndex: number;
    /** 是否调整农历闰月（若该月不是闰月则不会生效），调整后闰月十五日之后按下月算 */
    fixLeap?: boolean;
    /** 性别，不是每个方法都需要性别，所以将之设置为可选 */
    gender?: GenderName;
    /** 五行局起始干支，用于中州派的地盘、人盘排法，不传该参数即为天盘数据 */
    from?: {
        heavenlyStem: HeavenlyStemName;
        earthlyBranch: EarthlyBranchName;
    };
};