iztro

https://github.com/sylarlong/iztro
Admin
iztro is a lightweight open-source JavaScript library for generating astrolabes for Zi Wei Dou Shu...
Tokens:144,623
Snippets:1,167
Trust Score:8.8
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Run frontend

Source: https://github.com/sylarlong/iztro/blob/main/examples/fullstack-demo/README.md

Commands to install dependencies and start the frontend development server.

```bash
cd frontend
npm install
npm run dev
```

--------------------------------

### Run Node.js backend

Source: https://github.com/sylarlong/iztro/blob/main/examples/fullstack-demo/README.md

Commands to install dependencies and start the Node.js backend server.

```bash
cd backend
npm install
cp .env.example .env
# edit .env and set IZTRO_API_KEY
npm run dev
```

--------------------------------

### Example user input

Source: https://github.com/sylarlong/iztro/blob/main/examples/fullstack-demo/README.md

A sample prompt for birth detail analysis.

```text
My birthday is 1995-02-23, birth hour 17, female. Analyze my 2026 career.
```

--------------------------------

### Usage of withOptions

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Example of calling withOptions to retrieve an astrolabe object.

```typescript
import { astro } from "iztro";

const astrolabe = astro.withOptions({
    type: 'solar',
    dateStr: '1999-12-29',
    timeIndex: 2,
    gender: 'female',
    isLeapMonth: false,
    fixLeap: true,
    language: 'zh-CN'
  })
```

--------------------------------

### Retrieve Palace Instance

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Example of retrieving a palace by index or name.

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

// 获取 `寅宫`
const palace = astrolabe.palace(0);

// 获取 `命宫`
const soulPalace = astrolabe.palace("命宫");
```

--------------------------------

### Example of star usage

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/astrolabe.html

Retrieves the palace location of a specific star.

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

// 獲取 `紫微星` 所在宮位
const star = astrolabe.star("紫微");
```

--------------------------------

### Get Yearly Surround Palaces

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/horoscope.html

Example of retrieving the surrounding palaces for a yearly spouse palace.

```typescript
import { astro } from "iztro";

const astrolabe = astro
  .astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");
const surpalaces = astrolabe
  .horoscope('2023-10-26', 2)
  .surroundPalaces("夫妻", "yearly");
```

--------------------------------

### Retrieve Star Instance

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Example of retrieving a star instance from an astrolabe.

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

// 获取 `紫微星` 所在宫位
const star = astrolabe.star("紫微");
```

--------------------------------

### Run Python backend

Source: https://github.com/sylarlong/iztro/blob/main/examples/fullstack-demo/README.md

Commands to set up a virtual environment and start the Python backend server.

```bash
cd python-backend
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
cp .env.example .env
# edit .env and set IZTRO_API_KEY
uvicorn app.main:app --reload --host 0.0.0.0 --port 8787
```

--------------------------------

### Run Chat Completions Examples

Source: https://github.com/sylarlong/iztro/blob/main/examples/chat-api/README.md

Execute scripts compatible with the /v2/chat/completions endpoint for OpenAI-compatible clients.

```javascript
node chat-completion.js
```

```python
python chat_completion.py
```

--------------------------------

### Initialize FunctionalAstrolabe

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Example of initializing an astrolabe using a solar date.

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");
const horoscope = astrolabe.horoscope();
```

--------------------------------

### Install iztro dependencies

Source: https://github.com/sylarlong/iztro/blob/main/README.md

Use standard package managers to add iztro to your project.

```shell
# npm
npm install iztro -S

# yarn
yarn add iztro

# pnpm
pnpm install iztro -S
```

--------------------------------

### Run Multi-turn Conversation Examples

Source: https://github.com/sylarlong/iztro/blob/main/examples/chat-api/README.md

Execute the multi-turn conversation scripts to maintain context during chat sessions.

```javascript
node chat-session.js
```

```python
python chat_session.py
```

--------------------------------

### Verify iztro installation

Source: https://github.com/sylarlong/iztro/blob/main/docs/quick-start.html

Check the package.json file to confirm that iztro has been added as a dependency.

```json
"dependencies": {
  "iztro": "^1.1.0"
}
```

--------------------------------

### Get Decadal Spouse Palace

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/horoscope.html

Example of retrieving the spouse palace for a specific decadal scope.

```typescript
import { astro } from "iztro";

const astrolabe = astro
  .astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");
const spousePalace = astrolabe
  .horoscope('2023-10-26', 2)
  .palace("夫妻", "decadal");
```

--------------------------------

### Retrieve Horoscope Data

Source: https://github.com/sylarlong/iztro/blob/main/docs/quick-start.html

Example of initializing an astrolabe and fetching horoscope data for a specific date.

```typescript
import { astro } from "iztro";

// 通过阳历获取星盘信息
const astrolabe = astro.bySolar("2000-8-16", 2, "女");

// 获取运限数据
astrolabe.horoscope(new Date());
```

--------------------------------

### Usage of getMajorStarBySolarDate

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Example of retrieving major stars from a solar date.

```typescript
import { astro } from 'isztro';

const result = getMajorStarBySolarDate('2023-4-7', 0);
```

```typescript
贪狼
```

--------------------------------

### Retrieve Surrounded Palaces

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Example of retrieving the 'three-party and four-square' palaces.

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

// 获取 `寅宫` 三方四正
const surroundedPalaces = astrolabe.surroundedPalaces(0);

// 获取 `命宫` 三方四正
const surroundedPalacesOfSoul = astrolabe.surroundedPalaces("命宫");
```

--------------------------------

### FunctionalPalace Usage Example

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/palace.html

Basic usage of the FunctionalPalace interface to check for mutagens in a specific palace.

```javascript
const result = astrolabe.palace("命宮").notHaveMutagen("忌");
```

--------------------------------

### Retrieve astrolabe by solar date

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/astrolabe.html

Example usage of the astro.astrolabeBySolarDate method to generate an astrolabe.

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", false, true, "zh-CN");
```

--------------------------------

### Check stars in palace with has()

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/palace.html

Examples of checking if specific stars are present in a palace.

```typescript
const palace = astrolabe.palace("命宮");
const result = palace.has(["紫微", "右弼"]);
```

```typescript
const result = astrolabe.palace("命宮").has(["紫微", "右弼"]);
```

--------------------------------

### Usage of getMajorStarByLunarDate

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Example of retrieving major stars from a lunar date.

```typescript
import { astro } from 'isztro';

const result = getMajorStarByLunarDate('2023-2-17', 0, true, false);
```

```typescript
紫微,贪狼
```

--------------------------------

### Example of surroundedPalaces usage

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/astrolabe.html

Retrieves the three-party and four-rectitude palaces for a given palace.

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

// 獲取 `寅宮` 三方四正
const surroundedPalaces = astrolabe.surroundedPalaces(0);

// 獲取 `命宮` 三方四正
const surroundedPalacesOfSoul = astrolabe.surroundedPalaces("命宮");
```

--------------------------------

### Check for horoscope stars

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/horoscope.html

Initial setup for horoscope analysis using astrolabeBySolarDate and horoscope methods.

```typescript
const astrolabe = astro
  .astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");
const flag = astrolabe
  .horoscope('2023-10-26', 2)
  .notHaveHoroscopeStars("夫妻", "yearly", ["流喜", "流曲"]);
```

--------------------------------

### Transient Star Data Structure

Source: https://github.com/sylarlong/iztro/blob/main/docs/quick-start.html

Example of the array structure returned by the getHoroscopeStar method.

```typescript
[
  [{ name: "运马", type: "tianma", scope: "decadal" }],
  [{ name: "运曲", type: "soft", scope: "decadal" }],
  [],
  [{ name: "运喜", type: "flower", scope: "decadal" }],
  [],
  [
    { name: "运钺", type: "soft", scope: "decadal" },
    { name: "运陀", type: "tough", scope: "decadal" },
  ],
  [{ name: "运禄", type: "lucun", scope: "decadal" }],
  [{ name: "运羊", type: "tough", scope: "decadal" }],
  [],
  [
    { name: "运昌", type: "soft", scope: "decadal" },
    { name: "运鸾", type: "flower", scope: "decadal" },
  ],
  [],
  [{ name: "运魁", type: "soft", scope: "decadal" }],
];
```

--------------------------------

### Use hasHoroscopeMutagen

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/horoscope.html

Example of checking if a palace contains a specific horoscope mutagen.

```typescript
import { astro } from "iztro";

const astrolabe = astro
  .astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");
const flag = astrolabe
  .horoscope('2023-10-26', 2)
  .hasHoroscopeMutagen("夫妻", "yearly", "禄");
```

--------------------------------

### Check for mutagen with hasMutagen()

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/palace.html

Examples of checking if a specific mutagen is present in a palace.

```typescript
const palace = astrolabe.palace("命宮");
const result = palace.hasMutagen("祿");
```

```typescript
const result = astrolabe.palace("命宮").hasMutagen("祿");
```

--------------------------------

### Check palace for mutagen

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/palace.html

Examples of checking if a palace contains a specific mutagen.

```typescript
const palace = astrolabe.palace("命宫");
const result = palace.hasMutagen("禄");
```

```typescript
const result = astrolabe.palace("命宫").hasMutagen("禄");
```

--------------------------------

### Use hasOneOfHoroscopeStars

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/horoscope.html

Example of checking if a palace contains at least one of the specified horoscope stars.

```typescript
import { astro } from "iztro";

const astrolabe = astro
  .astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");
const flag = astrolabe
  .horoscope('2023-10-26', 2)
  .hasOneOfHoroscopeStars("夫妻", "yearly", ["流喜", "流曲"]);
```

--------------------------------

### Retrieve astrolabe by lunar date

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Example usage of the byLunar method to generate an astrolabe for a specific lunar date and gender.

```typescript
import { astro } from "iztro";

const astrolabe = astro.byLunar("2000-8-16", 2, "女", false, true, "zh-CN");
```

--------------------------------

### Check palace for absence of mutagen

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/palace.html

Examples of checking if a palace does not contain a specific mutagen.

```typescript
const palace = astrolabe.palace("命宫");
const result = palace.notHaveMutagen("忌");
```

```typescript
const result = astrolabe.palace("命宫").notHaveMutagen("忌");
```

--------------------------------

### Check palace for stars

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/palace.html

Examples of checking if a palace contains specific stars using direct and chained calls.

```typescript
const palace = astrolabe.palace("命宫");
const result = palace.has(["紫微", "右弼"]);
```

```typescript
const result = astrolabe.palace("命宫").has(["紫微", "右弼"]);
```

--------------------------------

### Define withOptions Type and Usage

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/astrolabe.html

Defines the structure for astrolabe options and demonstrates how to initialize an astrolabe using solar date parameters.

```typescript
type Option = {
  type: 'solar' | 'lunar';
  dateStr: string;
  timeIndex: number;
  gender: GenderName;
  isLeapMonth?: boolean;
  fixLeap?: boolean;
  language?: Language;
  config?: Config;
};

export type withOptions = (
  option: Option
) => FunctionalAstrolabe;
```

```typescript
import { astro } from "iztro";

const astrolabe = astro.withOptions({
  type: 'solar',
  dateStr: '1999-12-29',
  timeIndex: 2,
  gender: 'female',
  isLeapMonth: false,
  fixLeap: true,
  language: 'zh-CN'
})
```

--------------------------------

### withOptions

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Retrieves comprehensive astrolabe information based on provided options including date, time, gender, and configuration.

```APIDOC
## withOptions

### Description
Retrieves astrolabe information. This is a wrapper method that internally calls `bySolar` or `byLunar` for convenience.

### Parameters
- **type** (string) - Optional - 'solar' | 'lunar' (Default: 'solar')
- **dateStr** (string) - Required - Birth date in YYYY-M-D format
- **timeIndex** (number) - Required - Birth time index [0~12]
- **gender** (string) - Required - Gender ('male' | 'female')
- **isLeapMonth** (boolean) - Optional - Whether it is a leap month (Default: false)
- **fixLeap** (boolean) - Optional - Whether to adjust leap month (Default: true)
- **language** (string) - Optional - Language code (Default: 'zh-CN')
- **config** (object) - Optional - Custom configuration for brightness, SiHua, and time segments

### Request Example
{
  "type": "solar",
  "dateStr": "1999-12-29",
  "timeIndex": 2,
  "gender": "female",
  "isLeapMonth": false,
  "fixLeap": true,
  "language": "zh-CN"
}
```

--------------------------------

### Include iztro in static HTML

Source: https://github.com/sylarlong/iztro/blob/main/README.md

Load the library via a script tag to access the iztro global object in browser environments.

```html
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>iztro-紫微斗数开源库</title>
  </head>
  <body>
    <script src="./iztro.min.js"></script>
    <script>
      // 获取一张星盘数据
      var astrolabe = iztro.astro.bySolar('2000-8-16', 2, '男', true, 'zh-CN');
    </script>
  </body>
</html>
```

--------------------------------

### Invoke Plugin Methods on Astrolabe

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/config-n-plugin.html

Demonstrates calling custom methods defined by plugins on an initialized astrolabe instance.

```javascript
    const astrolabe = astro.bySolar<IAstrolabe>('2023-10-18', 4, 'female');
    
     // 使用插件定義的方法
     astrolabe.myNewFunc();   // 火六局
    
     // 使用第二個插件方法
     astrolabe.majorStar();   // 七殺
```

--------------------------------

### withOptions

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/astrolabe.html

Retrieves comprehensive astrolabe information based on provided birth details.

```APIDOC
## withOptions

### Description
Retrieves astrolabe information. This is a wrapper method that internally calls `bySolar` or `byLunar` for convenience.

### Parameters
- **option** (Object) - Required
  - **type** ('solar' | 'lunar') - Optional - Default: 'solar' - Date type.
  - **dateStr** (string) - Required - Birth date in YYYY-M-D format.
  - **timeIndex** (number) - Required - Birth time index [0~12].
  - **gender** (GenderName) - Required - Gender (male/female).
  - **isLeapMonth** (boolean) - Optional - Default: false - Whether it is a leap month.
  - **fixLeap** (boolean) - Optional - Default: true - Whether to adjust leap month logic.
  - **language** (Language) - Optional - Default: 'zh-CN' - Internationalization language.
  - **config** (Config) - Optional - Custom configuration for brightness, SiHua, and time split points.

### Returns
- **FunctionalAstrolabe** - The resulting astrolabe object.

### Example
```typescript
import { astro } from "iztro";

const astrolabe = astro.withOptions({
  type: 'solar',
  dateStr: '1999-12-29',
  timeIndex: 2,
  gender: 'female',
  isLeapMonth: false,
  fixLeap: true,
  language: 'zh-CN'
});
```
```

--------------------------------

### 挂载插件

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/config-n-plugin.html

使用loadPlugin或loadPlugins方法将定义好的插件函数挂载到astro实例中。

```typescript
import {astro} from iztro;

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

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

--------------------------------

### Check absence of stars with notHave()

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/palace.html

Examples of checking if specific stars are absent from a palace.

```typescript
const palace = astrolabe.palace("命宮");
const result = palace.notHave(["地空", "地劫"]);
```

```typescript
const result = astrolabe.palace("命宮").notHave(["地空", "地劫"]);
```

--------------------------------

### Set API Key Environment Variable

Source: https://github.com/sylarlong/iztro/blob/main/examples/chat-api/README.md

Configure the IZTRO_API_KEY environment variable before running API requests.

```bash
export IZTRO_API_KEY="sk_..."
```

```powershell
$env:IZTRO_API_KEY="sk_..."
```

--------------------------------

### POST /v2/platform/sessions

Source: https://github.com/sylarlong/iztro/blob/main/README.md

Creates a new chat session for either Ziwei or Qimen analysis.

```APIDOC
## POST /v2/platform/sessions

### Description
Initializes a new chat session with a specific model (iztro-ziwei-v3 or iztro-qimen-v3).

### Method
POST

### Endpoint
https://chat-api.iztro.com/v2/platform/sessions

### Request Body
- **external_user_id** (string) - Required - Unique identifier for the user.
- **model** (string) - Required - The model to use (e.g., "iztro-ziwei-v3" or "iztro-qimen-v3").
- **system_prompt_override** (string) - Optional - Custom system instructions for the model.

### Request Example
{
  "external_user_id": "user_123",
  "model": "iztro-ziwei-v3",
  "system_prompt_override": "用简洁中文回答"
}
```

--------------------------------

### Check palace for absence of stars

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/palace.html

Examples of checking if a palace does not contain specific stars.

```typescript
const palace = astrolabe.palace("命宫");
const result = palace.notHave(["地空", "地劫"]);
```

```typescript
const result = astrolabe.palace("命宫").notHave(["地空", "地劫"]);
```

--------------------------------

### 在 HTML 中引入 iztro

Source: https://github.com/sylarlong/iztro/blob/main/README-zh_TW.md

通過 script 標籤引入壓縮後的 iztro.min.js 文件並調用 API。

```html
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>iztro-紫微鬥數開源庫</title>
  </head>
  <body>
    <script src="./iztro.min.js"></script>
    <script>
      // 獲取一張星盤數據
      var astrolabe = iztro.astro.bySolar('2000-8-16', 2, '男', true, 'zh-CN');
    </script>
  </body>
</html>
```

--------------------------------

### Define Configuration Types

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/type-definition.html

Types for global configuration including mutagens, brightness, and division settings.

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

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

```typescript
type Config = {
 // 星耀四化配置
 mutagens?: ConfigMutagens;
 // 星耀亮度配置
 brightness?: ConfigBrightness;
 // 年分割點配置
 yearDivide?: 'normal' | 'exact';
 // 運限分割點配置（^v2.4.3）
 horoscopeDivide?: 'normal' | 'exact';
 // 小限分割點配置，normal為以自然年分界，birthday為生日分界（^v2.4.5）
 // 預設為 normal
 ageDivide?: 'normal' | 'birthday';
};
```

--------------------------------

### Define ConfigBrightness

Source: https://github.com/sylarlong/iztro/blob/main/docs/type-definition.html

Defines the brightness parameters in the global configuration.

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

--------------------------------

### 配置全局参数

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/config-n-plugin.html

在调用排盘方法前使用astro.config()设置四化或星曜亮度，配置会与默认值合并。

```typescript
import { astro } from 'iztro';

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

--------------------------------

### Define Config

Source: https://github.com/sylarlong/iztro/blob/main/docs/type-definition.html

Defines the global configuration object for the project.

```typescript
type Config = {
  // 星耀四化配置
  mutagens?: ConfigMutagens;
  // 星耀亮度配置
  brightness?: ConfigBrightness;
  // 年分割点配置
  yearDivide?: 'normal' | 'exact';
  // 运限分割点配置（^v2.4.3）
  horoscopeDivide?: 'normal' | 'exact';
  // 小限分割点配置，normal为以自然年分界，birthday为生日分界（^v2.4.5）
  // 默认为 normal
  ageDivide?: 'normal' | 'birthday';
};
```

--------------------------------

### astro.bySolar(solarDateStr, timeIndex, gender, fixLeap, language)

Source: https://github.com/sylarlong/iztro/blob/main/docs/quick-start.html

Generates an astrolabe instance based on a solar date.

```APIDOC
## astro.bySolar

### Description
Calculates and returns an astrolabe instance based on the provided solar date and birth details.

### Parameters
- **solarDateStr** (string) - Required - Solar date in YYYY-M-D format.
- **timeIndex** (number) - Required - Birth time index (0-12).
- **gender** (string) - Required - Gender (男/女).
- **fixLeap** (boolean) - Optional (Default: true) - Whether to adjust for leap months.
- **language** (Language) - Optional (Default: zh-CN) - Language for internationalization (zh-CN, zh-TW, en-US, ko-KR, ja-JP).

### Returns
- **FunctionalAstrolabe** - The generated astrolabe object.
```

--------------------------------

### 实现插件函数

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/config-n-plugin.html

插件函数通过this上下文挂载自定义逻辑到星盘对象上。

```typescript
// 创建一个插件函数
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 ?? '';
  };
}
```

--------------------------------

### 判斷星曜亮度

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/star.html

使用 withBrightness() 方法判斷星曜是否處於指定的亮度狀態，支持傳入數組進行多項匹配。

```typescript
type withBrightness = (brightness: Brightness | Brightness[]) => boolean;
```

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

const result = astrolabe.star("紫微").withBrightness(["廟", "旺"]);
```

--------------------------------

### Check for Absence of Horoscope Stars

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/horoscope.html

Example of checking if specific stars are absent from a yearly spouse palace.

```typescript
import { astro } from "iztro";
```

--------------------------------

### palace() Method

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/star.html

Retrieves the palace where the star is located.

```typescript
type palace = () => IFunctionalPalace | undefined;
```

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

const palace = astrolabe.star("紫微").palace();
```

--------------------------------

### Check for Horoscope Stars

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/horoscope.html

Example of checking if specific stars exist within a yearly spouse palace.

```typescript
import { astro } from "iztro";

const astrolabe = astro
  .astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");
const flag = astrolabe
  .horoscope('2023-10-26', 2)
  .hasHoroscopeStars("夫妻", "yearly", ["流喜", "流曲"]);
```

--------------------------------

### Get Chinese Zodiac by Lunar Year

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Retrieves the Chinese zodiac animal for a specific lunar year.

```typescript
type getZodiacByLunarYear = (year: number, language?: Language) => string;
```

```typescript
import { astro } from 'isztro';

const result = getZodiacByLunarYear(2023);
```

```typescript
兔
```

--------------------------------

### getHoroscopeStar(stem: string, branch: string, scope: string)

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/type-definition.html

根據天干、地支和範圍獲取星曜信息，支持多語言輸入。

```APIDOC
## getHoroscopeStar

### Description
根據天干、地支和範圍獲取星曜信息。參數支持多語言輸入（如中文、韓文或拼音）。

### Parameters
- **stem** (string) - Required - 天干名稱
- **branch** (string) - Required - 地支名稱
- **scope** (string) - Required - 範圍，例如 'decadal'

### Request Example
```ts
import { getHoroscopeStar } from "iztro/lib/star";
getHoroscopeStar("甲", "子", "decadal");
```

### Response
#### Success Response (200)
- **Array** (Array) - 返回星曜對象數組，包含 name, type, scope 等屬性。
```

--------------------------------

### Get Chinese Zodiac by Solar Date

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Retrieves the Chinese zodiac animal for a given solar date.

```typescript
type getZodiacBySolarDate = (solarDateStr: string, language?: Language) => string;
```

```typescript
import { astro } from 'isztro';

const result = getZodiacBySolarDate('2023-2-20');
```

```typescript
兔
```

--------------------------------

### Check for at least one star with hasOneOf()

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/palace.html

Examples of checking if at least one of the provided stars is present in a palace.

```typescript
const palace = astrolabe.palace("命宮");
const result = palace.hasOneOf(["天魁", "天鉞"]);
```

```typescript
const result = astrolabe.palace("命宮").hasOneOf(["天魁", "天鉞"]);
```

--------------------------------

### 實現插件函數

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/config-n-plugin.html

定義插件函數以實現自定義邏輯，並掛載到星盤對象上。

```typescript
// 創建一個插件函數
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 ?? '';
  };
}
```

--------------------------------

### Check palace for at least one star

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/palace.html

Examples of checking if a palace contains at least one of the provided stars.

```typescript
const palace = astrolabe.palace("命宫");
const result = palace.hasOneOf(["天魁", "天钺"]);
```

```typescript
const result = astrolabe.palace("命宫").hasOneOf(["天魁", "天钺"]);
```

--------------------------------

### 獲取流耀數據

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/quick-start.html

使用 star.getHoroscopeStar 方法根據天干地支獲取大限或流年的流耀信息。

```typescript
import { star } from "iztro";

// 通過天干地支獲取流耀
const horoscopeStars = star.getHoroscopeStar("庚", "辰", "decadal");
```

--------------------------------

### 使用多语言参数调用方法

Source: https://github.com/sylarlong/iztro/blob/main/docs/type-definition.html

演示如何使用不同语言的干支作为参数调用 getHoroscopeStar 方法。

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

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

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

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

--------------------------------

### Get Zodiac Sign by Solar Date

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Calculates the zodiac sign based on a solar date string in YYYY-M-D format.

```typescript
type getSignBySolarDate = (
  solarDateStr: string, 
  language?: Language
) => string;
```

```typescript
import { astro } from 'isztro';

const result = getSignBySolarDate('2023-9-5');
```

```typescript
处女座
```

--------------------------------

### palace()

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/star.html

Retrieves the palace where the current star is located.

```APIDOC
## palace()

### Description
Returns the palace object where the star is currently positioned.

### Returns
- **FunctionalPalace | undefined** - The palace object or undefined if not found.

### Example
```typescript
import { astro } from "iztro";
const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");
const palace = astrolabe.star("紫微").palace();
```
```

--------------------------------

### Get Transient Stars

Source: https://github.com/sylarlong/iztro/blob/main/docs/quick-start.html

Use getHoroscopeStar to manually retrieve transient stars for decadal or yearly scopes using heavenly stems and earthly branches.

```typescript
import { star } from "iztro";

// 通过天干地支获取流耀
const horoscopeStars = star.getHoroscopeStar("庚", "辰", "decadal");
```

--------------------------------

### Get Zodiac Sign by Lunar Date

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Calculates the zodiac sign based on a lunar date string. Use the isLeapMonth parameter to specify if the month is a leap month.

```typescript
type getSignByLunarDate = (
  lunarDateStr: string, 
  isLeapMonth?: boolean, 
  language?: Language
) => string;
```

```typescript
import { astro } from 'isztro';

const result = getSignByLunarDate('2023-7-21');
```

```typescript
处女座
```

--------------------------------

### 声明插件接口

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/config-n-plugin.html

在TypeScript环境下，通过继承FunctionalAstrolabe接口来定义插件扩展的方法。

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

--------------------------------

### mutagedPlaces()

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/palace.html

Retrieves an array of 4 palaces that generate mutagens for the current palace, indexed by [Lu, Quan, Ke, Ji].

```APIDOC
## mutagedPlaces()

### Description
Retrieves an array of 4 palaces that generate mutagens for the current palace, indexed by [Lu, Quan, Ke, Ji].

### Signature
`type mutagedPlaces = () => (IFunctionalPalace | undefined)[];`

### Returns
- **(IFunctionalPalace | undefined)[]** - An array of palaces corresponding to the four mutagens.
```

--------------------------------

### setLanguage(language: string)

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/type-definition.html

設置全局輸出語言，影響後續調用方法的返回結果語言。

```APIDOC
## setLanguage

### Description
設置全局輸出語言，影響後續調用方法的返回結果語言。

### Parameters
- **language** (string) - Required - 語言代碼，例如 'ko-KR', 'zh-CN' 等。

### Request Example
```ts
import { setLanguage } from "iztro/lib/i18n";
setLanguage("ko-KR");
```
```

--------------------------------

### withBrightness()

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/star.html

Checks if the star matches the specified brightness level(s).

```APIDOC
## withBrightness(brightness)

### Description
Determines if the star's brightness matches one of the provided brightness values.

### Parameters
- **brightness** (Brightness | Brightness[]) - Required - The brightness level or array of levels to check.

### Returns
- **boolean** - True if the star matches any of the provided brightness levels.

### Example
```typescript
import { astro } from "iztro";
const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");
const result = astrolabe.star("紫微").withBrightness(["庙", "旺"]);
```
```

--------------------------------

### 导入astro对象

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

在安装iztro依赖后，使用ES6模块或CommonJS方式引入astro对象。

```javascript
import { astro } from "iztro";
```

```javascript
const { astro } = require("iztro");
```

```typescript
import { astro } from "iztro";
```

--------------------------------

### withBrightness() Method

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/star.html

Checks if the star matches the specified brightness level(s).

```typescript
type withBrightness = (brightness: Brightness | Brightness[]) => boolean;
```

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

const result = astrolabe.star("紫微").withBrightness(["庙", "旺"]);
```

--------------------------------

### 获取星盘示例

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

使用bySolar方法根据出生日期和性别生成星盘对象。

```typescript
import { astro } from "iztro";

const astrolabe = astro.bySolar("2000-8-16", 2, "女", true, "zh-CN");
```

--------------------------------

### FunctionalPalace Methods

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/palace.html

Methods available on the FunctionalPalace class for querying stars and mutagens.

```APIDOC
## FunctionalPalace Methods

### Description
The `FunctionalPalace` class provides utility methods to analyze the contents of a palace, such as checking for specific stars or mutagens.

### Methods
- `has(stars: StarName[])`: boolean - Checks if the palace contains all specified stars.
- `notHave(stars: StarName[])`: boolean - Checks if the palace does not contain any of the specified stars.
- `hasOneOf(stars: StarName[])`: boolean - Checks if the palace contains at least one of the specified stars.
- `hasMutagen(mutagen: Mutagen)`: boolean - Checks if the palace contains a specific mutagen.
- `notHaveMutagen(mutagen: Mutagen)`: boolean - Checks if the palace does not contain a specific mutagen.
- `isEmpty(excludeStars?: StarName[])`: boolean - Checks if the palace is empty, optionally excluding specific stars.
- `fliesTo(to: number | PalaceName, withMutagens: Mutagen | Mutagen[])`: boolean - Checks if the palace flies to another palace with specific mutagens.
- `selfMutaged(withMutagens: Mutagen | Mutagen[])`: boolean - Checks if the palace has specific self-mutagens.
```

--------------------------------

### 定义bySolar方法

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

通过阳历获取星盘信息的函数定义。

```typescript
export type bySolar = (
  solarDateStr: string,
  timeIndex: number,
  gender: GenderName,
  fixLeap: boolean = true,
  language: Language = "zh-CN"
) => FunctionalAstrolabe;
```

--------------------------------

### Accessing Palaces

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/palace.html

Methods to retrieve a palace object from an astrolabe instance.

```APIDOC
## Accessing Palaces

### Description
Palaces are accessed via the `astrolabe` object. You can retrieve them by index or by name.

### Methods
- `astrolabe.palaces[index]` (Array access)
- `astrolabe.palace(index: number)`
- `astrolabe.palace(name: string)`

### Example
```typescript
import { astro } from "iztro";
const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

// By index
const palaceByIndex = astrolabe.palace(1);

// By name
const palaceByName = astrolabe.palace("命宫");
```
```

--------------------------------

### astro.byLunar(lunarDateStr, timeIndex, gender, isLeapMonth, fixLeap, language)

Source: https://github.com/sylarlong/iztro/blob/main/docs/quick-start.html

Generates an astrolabe instance based on a lunar date.

```APIDOC
## astro.byLunar

### Description
Calculates and returns an astrolabe instance based on the provided lunar date and birth details.

### Parameters
- **lunarDateStr** (string) - Required - Lunar date in YYYY-M-D format.
- **timeIndex** (number) - Required - Birth time index (0-12).
- **gender** (string) - Required - Gender (男/女).
- **isLeapMonth** (boolean) - Optional (Default: false) - Whether it is a leap month.
- **fixLeap** (boolean) - Optional (Default: true) - Whether to adjust for leap months.
- **language** (Language) - Optional (Default: zh-CN) - Language for internationalization.

### Returns
- **FunctionalAstrolabe** - The generated astrolabe object.
```

--------------------------------

### 判斷星曜四化

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/star.html

使用 withMutagen() 方法判斷星曜是否產生了指定的四化，支持傳入數組進行多項匹配。

```typescript
type withMutagen = (mutagen: Mutagen | Mutagen[]) => boolean;
```

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

const result = astrolabe.star("紫微").withMutagen(["權", "科"]);
```

--------------------------------

### 使用插件方法

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/config-n-plugin.html

在排盘时指定泛型类型，即可调用插件中定义的方法。

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

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

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

--------------------------------

### Define withOptions Type

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

Type definition for the withOptions function and its configuration object.

```typescript
type Option = {
  type: 'solar' | 'lunar';
  dateStr: string;
  timeIndex: number;
  gender: GenderName;
  isLeapMonth?: boolean;
  fixLeap?: boolean;
  language?: Language;
  config?: Config;
};

export type withOptions = (
  option: Option
) => FunctionalAstrolabe;
```

--------------------------------

### palace()

Source: https://github.com/sylarlong/iztro/blob/main/docs/zh_TW/posts/astrolabe.html

Retrieves a specific palace from the astrolabe.

```APIDOC
## palace(indexOrName: number | PalaceName)

### Description
Retrieves the specified palace by its index or name.

### Parameters
- **indexOrName** (number | PalaceName) - Required - The index or name of the palace.

### Returns
- **IFunctionalPalace | undefined** - The palace instance or undefined if not found.
```

--------------------------------

### astro.bySolar

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/astrolabe.html

通过阳历日期、出生时辰、性别等参数获取星盘信息。

```APIDOC
## astro.bySolar

### Description
通过阳历日期获取星盘信息。该方法是生成紫微斗数命盘的核心入口。

### Method
Static Method

### Parameters
- **solarDateStr** (string) - Required - 阳历日期【YYYY-M-D】
- **timeIndex** (number) - Required - 出生时辰序号【0~12】，对应从早子时（0）一直到晚子时（12）的序号
- **gender** (GenderName) - Required - 性别【男/女】
- **fixLeap** (boolean) - Optional - 是否调整闰月，默认为 true。为 true 时闰月的前半个月算上个月，后半个月算下个月
- **language** (Language) - Optional - 返回数据国际化语言，默认为 "zh-CN"。支持 "zh-CN", "zh-TW", "en-US", "ko-KR", "ja-JP"

### Response
- **FunctionalAstrolabe** (Object) - 返回包含星盘详细信息的对象，包括阳历日期、农历日期、四柱、时辰、星座、生肖及命宫地支等。
```

--------------------------------

### withMutagen() Method

Source: https://github.com/sylarlong/iztro/blob/main/docs/posts/star.html

Checks if the star has specific mutagen (Si Hua) states.

```typescript
type withMutagen = (mutagen: Mutagen | Mutagen[]) => boolean;
```

```typescript
import { astro } from "iztro";

const astrolabe = astro.astrolabeBySolarDate("2000-8-16", 2, "女", true, "zh-CN");

const result = astrolabe.star("紫微").withMutagen(["权", "科"]);
```
Tokens:
Raw