Type definitions ​

Introduction ​

This page describes the types in iztro. Internationalized types are defined in i18n, while the other types are defined in types.

Import internationalized types with the following code:

import { HeavenlyStemName } from "iztro/lib/i18n";

To import other types, use:

import { Palace } from "iztro/lib/data/types";

Internationalized types ​

To support internationalized input and output, iztro defines localized values for its parameters and results. You can pass a value in any supported language: for example, a HeavenlyStemName can be 甲, 갑 or jia.

For example, when calling getHoroscopeStar(), you can pass the Chinese names of the Heavenly Stems（天干） and Earthly Branches（地支） as arguments:

import { getHoroscopeStar } from "iztro/lib/star";

getHoroscopeStar("甲", "子", "decadal");

You can also pass names in other supported languages, or mix languages in the same call:

import { getHoroscopeStar } from "iztro/lib/star";

getHoroscopeStar("갑", "zi", "decadal");

The output uses the language you select, regardless of the languages used in the input. Set the output language before calling the method:

import { setLanguage } from "iztro/lib/i18n";

setLanguage("ko-KR");

const horoscopeStar = getHoroscopeStar("甲", "zi", "decadal");

The output of horoscopeStar will then be in Korean.

[
  [
    {
      "name": "록존(십년)",
      "type": "lucun",
      "scope": "decadal"
    },
    {
      "name": "천마(십년)",
      "type": "tianma",
      "scope": "decadal"
    }
  ],
  [
    {
      "name": "경양(십년)",
      "type": "tough",
      "scope": "decadal"
    },
    {
      "name": "홍란(십년)",
      "type": "flower",
      "scope": "decadal"
    }
  ],
  [],
  [
    {
      "name": "문창(십년)",
      "type": "soft",
      "scope": "decadal"
    }
  ],
  [],
  [
    {
      "name": "천월(십년)",
      "type": "soft",
      "scope": "decadal"
    }
  ],
  [],
  [
    {
      "name": "문곡(십년)",
      "type": "soft",
      "scope": "decadal"
    },
    {
      "name": "천희(십년)",
      "type": "flower",
      "scope": "decadal"
    }
  ],
  [],
  [],
  [],
  [
    {
      "name": "천괴(십년)",
      "type": "soft",
      "scope": "decadal"
    },
    {
      "name": "타라(십년)",
      "type": "tough",
      "scope": "decadal"
    }
  ]
]

HeavenlyStemName ​

Defines the names of the ten Heavenly Stems（十天干）.

EarthlyBranchName ​

Defines the twelve Earthly Branches（十二地支）. The standard romanization of the Earthly Branch woo（午） and the Heavenly Stem wu（戊） is “wu” in both cases. To avoid a naming conflict in multilingual input, the library represents the branch woo（午） as woo.

PalaceName ​

Defines the Name of Zi Wei Dou Shu（紫微斗數） palaces（宮位）.

Brightness ​

Defines star（星曜） brightness.

Mutagen ​

Defines the name of four transformation stars（四化星） in Zi Wei Dou Shu（紫微斗數）

StarName ​

Defines the names of stars（星曜） in Zi Wei Dou Shu（紫微斗數）, including transit stars（流曜）.

FiveElementsClassName ​

Defines the name of Five Elements Class（五行局） in Zi Wei Dou Shu（紫微斗數）

GenderName ​

Defines the names used for gender.

Common types ​

Language ​

export type Language = `zh-CN` | `zh-TW` | `en-US` | `ko-KR` | `ja-JP` | `vi-VN`;

Defines the supported language values:

• zh-CN: Simplified Chinese
• zh-TW: Traditional Chinese
• en-US：English
• ko-KR：한국어
• ja-JP: Japanese
• vi-VN: Vietnamese

Scope ​

export type Scope = "origin" | "decadal" | "yearly";

Defines the scope of stars（星曜）, distinguishing natal stars（本命星曜） from transit stars（流曜）:

• origin: natal stars（本命星曜）
• decadal: decadal-cycle stars（大限星曜）
• yearly: yearly transit stars（流年星曜）

StarType ​

export type StarType =
  | "major"
  | "soft"
  | "tough"
  | "adjective"
  | "flower"
  | "helper"
  | "lucun"
  | "tianma";

Defines star（星曜） Type. Although romance stars（桃花星） and considery（解神） (including considery(Y)（年解）) are miscellaneous stars（雜曜）, they have special significance in chart interpretation and are therefore classified separately. The two auxiliary stars money（祿存） and horse（天馬） also have distinct roles, so each has its own category:

• major: major stars（主星）
• soft: auspicious stars（吉星）
• tough: malefic stars（煞星）
• adjective: miscellaneous stars（雜曜）
• flower: romance stars（桃花）
• helper：considery（解神）
• lucun：money（祿存）
• tianma：horse（天馬）

Stars（星曜） ​

Star ​

export type Star = {
  name: StarName;
  type: StarType;
  scope: Scope;
  brightness?: Brightness;
  mutagen?: Mutagen;
};

Defines the data structure for stars（星曜）.

Palaces（宮位） ​

SoulAndBody ​

export type SoulAndBody = {
  soulIndex: number;
  bodyIndex: number;
  heavenlyStemOfSoul: HeavenlyStemName;
  earthlyBranchOfSoul: EarthlyBranchName;
};

Defines the positions of the soul（命宮） and body（身宮） palaces.

Palace ​

export type Palace = {
  name: PalaceName;
  isBodyPalace: boolean;
  isOriginalPalace: boolean;
  heavenlyStem: HeavenlyStemName;
  earthlyBranch: EarthlyBranchName;
  majorStars: Star[];
  minorStars: Star[];
  adjectiveStars: Star[];
  changsheng12: StarName;
  boshi12: StarName;
  jiangqian12: StarName;
  suiqian12: StarName;
  decadal: Decadal;
  ages: number[];
};

Defines the data structure for palaces（宮位）.

SurroundedPalaces ​

export type SurroundedPalaces = {
  target: IFunctionalPalace;
  opposite: IFunctionalPalace;
  wealth: IFunctionalPalace;
  career: IFunctionalPalace;
};

Defines an object containing the trine and opposite palaces（三方四正）.

Horoscope periods（運限） ​

HoroscopeItem ​

export type HoroscopeItem = {
  index: number;
  name: string;
  heavenlyStem: HeavenlyStemName;
  earthlyBranch: EarthlyBranchName;
  palaceNames: PalaceName[];
  mutagen: StarName[];
  stars?: Star[][];
};

Defines the data structure used for individual horoscope periods（運限）.

Decadal ​

export type Decadal = {
  range: [number, number];
  heavenlyStem: HeavenlyStemName;
  earthlyBranch: EarthlyBranchName;
};

Defines the chart’s decadal（大限） data. This type is mainly used in Palace.

DecadalHoroscope ​

export type DecadalHoroscope = HoroscopeItem & {
  palaceName: PalaceName;
  ageRange: [number, number];
  yearRange: [number, number];
};

Defines a decadal-cycle（大限） list item returned by decadalList().

This type also contains all attributes of HoroscopeItem.

YearlyHoroscope ​

export type YearlyHoroscope = HoroscopeItem & {
  age: number;
  year: number;
};

Defines a yearly-cycle（流年） list item returned by yearlyList().

This type also contains all attributes of HoroscopeItem.

MonthlyHoroscope ​

export type MonthlyHoroscope = YearlyHoroscope & {
  month: number;
  isLeapMonth: boolean;
  part: 'normal' | 'first' | 'second';
  dayRange: [number, number];
};

Defines a monthly-cycle（流月） list item returned by monthlyList().

This type contains all properties of both YearlyHoroscope and HoroscopeItem.

Horoscope ​

export type Horoscope = {
  lunarDate: string;
  solarDate: string;
  decadal: HoroscopeItem;
  age: {
    index: number;
    nominalAge: number;
  };
  yearly: HoroscopeItem & {
    yearlyDecStar: {
      jiangqian12: StarName[];
      suiqian12: StarName[]
      }
    };
  monthly: HoroscopeItem;
  daily: HoroscopeItem;
  hourly: HoroscopeItem;
};

Defines a horoscope-period（運限） object containing decadal（大限）, yearly（流年）, monthly（流月）, daily（流日）, and hourly（流時） data.

Chart（星盤） ​

Astrolabe ​

export type Astrolabe = {
  gender: GenderName;
  solarDate: string;
  lunarDate: string;
  chineseDate: string;
  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[];
};

Defines a chart（星盤） object.

Configuration and plugins ^2.3.0 ​

ConfigMutagens ​

Defines the four transformations（四化） parameter in the global configuration.

type ConfigMutagens = Partial<Record<HeavenlyStemName, StarName[]>>;

ConfigBrightness ​

Defines the brightness parameter in the global configuration.

type ConfigBrightness = Partial<Record<StarName, Brightness[]>>;

Config ​

Defines chart-calculation settings. Use astro.config() to set defaults for subsequently generated charts, or withOptions({ config }) to override the settings for just the chart being generated. Existing charts retain the settings used at their creation (^2.6.2).

type Config = {
  // 星曜四化配置
  mutagens?: ConfigMutagens;
  // 星曜亮度配置
  brightness?: ConfigBrightness;
  // 年分割点配置
  yearDivide?: 'normal' | 'exact';
  // 运限分割点配置（^v2.4.3）
  horoscopeDivide?: 'normal' | 'exact';
  // 小限分割点配置，normal为以自然年分界，birthday为生日分界（^v2.4.5）
  // 默认为 normal
  ageDivide?: 'normal' | 'birthday';
  // 晚子时配置，current 时晚子时算当日，forward 时晚子时算次日（^v2.5.2）
  // 默认为 forward
  dayDivide?: 'current' | 'forward';
  // 安星方法，default 为通行版本，zhongzhou 为中州派版本（^v2.5.0）
  // 默认为 default
  algorithm?: 'default' | 'zhongzhou';
};

For yearDivide and horoscopeDivide, normal uses the first day of the first Chinese lunar month as the year boundary, while exact uses the solar term Start of Spring（立春）.

dayDivide only controls which calendar day the late Zi hour（晚子時） belongs to (timeIndex is 12): forward assigns it to the following day, and current assigns it to the current day.

AstroType ^2.5.0 ​

Defines the chart type used by the Zhongzhou school（中州派）.

type AstroType = 'heaven' | 'earth' | 'human';

Plugin ​

Defines the plugin type. A plugin is simply a function.

type Plugin = () => void;