iztro/lib/star/FunctionalStar.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 { IFunctionalAstrolabe } from '../astro/FunctionalAstrolabe';
import { IFunctionalPalace } from '../astro/FunctionalPalace';
import { IFunctionalSurpalaces } from '../astro/FunctionalSurpalaces';
import { Star } from '../data/types';
import { Brightness, Mutagen } from '../i18n';
/**
 * 星耀类的接口定义
 *
 * 文档地址：https://docs.iztro.com/posts/star.html#functionalstar
 */
export interface IFunctionalStar extends Star {
    /**
     * 获取星耀所在宫位
     *
     * @version v1.2.0
     *
     * @returns 星耀所在宫位
     */
    palace: () => IFunctionalPalace | undefined;
    /**
     * 设置当前星耀所在宫位
     *
     * @param p 宫位的实例
     */
    setPalace: (p: IFunctionalPalace) => void;
    /**
     * 设置当前星耀所在星盘
     *
     * @version v1.2.0
     *
     * @param a 星盘实例
     */
    setAstrolabe: (a: IFunctionalAstrolabe) => void;
    /**
     * 获取当前星耀的三方四正宫位
     *
     * @version v1.2.0
     *
     * @returns 三方四正宫位 ｜ undefined
     */
    surroundedPalaces: () => IFunctionalSurpalaces | undefined;
    /**
     * 获取当前星耀的对宫
     *
     * @version v1.2.0
     *
     * @returns 对宫 ｜ undefined
     */
    oppositePalace: () => IFunctionalPalace | undefined;
    /**
     * 判断星耀是否是传入的亮度，也可以传入多个亮度，只要匹配到一个亮度就会返回 `true`
     *
     * @version v1.2.0
     *
     * @param brightness 星耀亮度
     * @returns true | false
     */
    withBrightness: (brightness: Brightness | Brightness[]) => boolean;
    /**
     * 判断星耀是否产生了四化
     *
     * @version v1.2.0
     *
     * @param mutagen 四化【禄|权|科|忌】
     * @returns true | false
     */
    withMutagen: (mutagen: Mutagen | Mutagen[]) => boolean;
}
/**
 * 星耀类。
 *
 * 文档地址：https://docs.iztro.com/posts/star.html
 */
export default class FunctionalStar implements IFunctionalStar {
    name: import("../i18n").StarName;
    type: import("../data/types").StarType;
    scope: import("../data/types").Scope;
    brightness?: Brightness | undefined;
    mutagen?: Mutagen | undefined;
    private _palace?;
    private _astrolabe?;
    constructor(data: Star);
    oppositePalace: () => IFunctionalPalace | undefined;
    setPalace: (p: IFunctionalPalace) => void;
    setAstrolabe: (a: IFunctionalAstrolabe) => void;
    palace: () => IFunctionalPalace | undefined;
    surroundedPalaces: () => IFunctionalSurpalaces | undefined;
    withMutagen: (mutagen: Mutagen | Mutagen[]) => boolean;
    withBrightness: (brightness: Brightness | Brightness[]) => boolean;
}