lunisolar/plugins/types.d.ts

专业农历库，支持公历阴历互转，支持各类黄历数据查询，如八字四柱、阴历、神煞宜忌、时辰吉凶、建除十二神、胎神占方、五行纳音等。支持自定义插件。

type FetalGodData = {
  stemPlace: string
  branchPlace: string
  directionValue: number
  direction: string
  description: string
}

type YMDH = 'year' | 'month' | 'day' | 'hour'

type YmdhSu = 'Y' | 'M' | 'D' | 'H'
type YmdhSl = 'y' | 'm' | 'd' | 'h'

type CheckGodFunc = {
  <T = number>(lsr: Lunisolar, fromYmdh?: YMDH): T
  <T = number>(lsr: Lunisolar, fromYmdh: YMDH | undefined, toYmdh: null): T
  (lsr: Lunisolar, fromYmdh: YMDH | undefined, toYmdh: YMDH): boolean
}

type ActsDictList = {
  good: string[]
  bad: string[]
}

type GodDictItemExtraFilterFunc = (
  lsr: lunisolar.Lunisolar,
  gods: Set<string>
) => {
  add?: Partial<ActsDictList>
  remove?: Partial<ActsDictList>
  replace?: Partial<ActsDictList>
  gRemove?: Partial<ActsDictList>
  gOnlySign?: string[]
  meetGodStillBad?: string[]
  meetDeStillBad?: true
  meetWishStillBad?: true
  isAllBad?: true
} | null

/**
 * 神煞宜忌补充
 ```
 meetDeStillBad 是否遇德犹忌
 meetGodStillBad 遇到某些神煞犹忌 填写神煞key列表
 meetGodFilter: 遇到某些神煞要对宜忌进行筛选
  {
    withGodKeys： 神煞key列表
    acts: 宜或忌列表
    flag: 0犹忌， 1只忌， 2不忌, 3宜, 4不宜
  }
 ```
 */
type GodDictItemExtra = {
  alias?: sting[]
  showGB?: boolean
  checkBy?: 'branch' | 'stem' | 'sb'
  meetDeStillBad?: boolean
  meetWishStillBad?: true
  meetGodStillBad?: string[]
  actsFilter?: GodDictItemExtraFilterFunc
  [key: string]: any
}

type GodDictItem =
  | [CheckGodFunc, string[] | null, string[] | null, number]
  | [CheckGodFunc, string[] | null, string[] | null, number, GodDictItemExtra]
  | [CheckGodFunc, string[] | null, string[] | null, number, undefined]

type GodBaseClassData = {
  key: string
  good: string[]
  bad: string[]
  luckLevel: number
  cate: YMDH | null
  alias: string[]
  extra: GodDictItemExtra | null
}

type GodBaseClassDataParam = {
  key: string
  good: string[] | null
  bad: string[] | null
  luckLevel?: number
  cate?: YMDH | null
  extra?: GodDictItemExtra | null
}

type FromGodsType =
  | 'common'
  | 'year'
  | 'month'
  | 'day'
  | 'hour'
  | 'monthSeason'
  | 'duty'
  | 'blackYellow'
  | 'life'
type GodClassOpt = {
  godBase?: GodBase
  key?: string
  cate?: YMDH
  fromDict?: FromDictType
  lang?: string
}

type ActsSet = {
  good: Set<string>
  bad: Set<string>
}

type DayLuckDirectionGodRes = [lunisolar.Direction24, God]

type DayLuckDirectionGodNames = '喜神' | '福神' | '財神' | '陽貴' | '陰貴'