// 引入lunisolar
import lunisolar from 'lunisolar'
// 引入 theGods 插件
import { theGods } from '@lunisolar/plugin-thegods'
// 加载插件
lunisolar.extend(theGods)

// ---  使用
const lsr = lunisolar('2018-10-04')
// 取神煞
lsr.theGods.getGods('M') // 取得当日的月神
lsr.theGods.getGods('D') // 取得当日的日神
lsr.theGods.getGods('MD') // 取得当日的月神和日神
lsr.theGods.getDuty12God() // 取得当日建除十二神（建、除、满....）
lsr.theGods.getLife12God('day') // 取得当日长生十二神 (长生、沐浴、冠帶...)
lsr.theGods.getBy12God('day') // 取得当日串宫十二神（青龍、明堂、天刑...）

// 取宜忌
lsr.theGods.getActs(0) // 取得当日宜忌 {good: string[], bad: string[]}
lsr.theGods.query('this day gods') // 取得当日神煞 （用于取宜忌的神煞）
lsr.theGods.query('good act 1') // 取得当日所宜（通书六十事）
lsr.theGods.query('bad act 1') // 取得当日所忌（通书六十事）
lsr.theGods.query('good act 2') // 取得当日所宜（御用六十七事）
lsr.theGods.query('good act 2') // 取得当日所忌（御用六十七事）
lsr.theGods.query('good act 3') // 取得当日所宜（民三十七事）
lsr.theGods.query('good act 3') // 取得当日所忌（民用三十七事）
lsr.theGods.query('good act') // 取得当日所宜（卷十一的所有词条）
lsr.theGods.query('bad act') // 取得当日所忌（卷十一的所有词条）

// 取得当日所有时辰吉凶
lunisolar('2022-10-21').theGods.getLuckHours() // [-1, -1, 1, 1, -1, 1, -1, -1, 1, -1, 1, 1] 大于0为吉，少于0为凶

// 取得当日吉神所在方位
const [d24, god] = lunisolar('2022-11-25').theGods.getLuckDirection('財神')
d24.direction // 南
d24.sign.toString() // 午
d24.angle // 180


// 更多和详细用法请继续往下阅读

theGods.getDuty12God()

theGods.getDuty12God(ymdh: 'year' | 'month' | 'day' | 'hour'): God

ymdh: 'year' | 'month' | 'day' | 'hour'

theGods.getBy12God(dh: 'day' | 'hour'): God

dh: 'day' | 'hour'

theGods.getGods(ymdh: 'Y' | 'M' | 'D' | 'H' | string): God[]

ymdh?: 'Y' | 'M' | 'D' | 'H' | string
// 默认值为 "MD"

lunisolar().theGods.getGods('YMD') // 同时取得年、月、日神
lunisolar().theGods.getGods('MD') // 同时取得月、日神

theGods.getGoodGods(ymdh: 'Y' | 'M' | 'D' | 'H' | string): God[]

theGods.getBadGods(ymdh: 'Y' | 'M' | 'D' | 'H' | string): God[]

theGods.getActs(actType?: 0 | 1 | 2 | 3, returnKey?: boolean, replacer?: {}): {good: string[], bad: string[]}

actType: 0 | 1 | 2 | 3
/**
 宜忌类型
 defalut: 0
 0：所有词条，不会按通书、御用、民事里的词条进行筛选
 1：按`通书六十事`的词条进行筛选，不在此60个词条内者，不会出现
 2：按`御用六十七事`的词条进行筛选
 3: 按`民用三十七事`的词条进行筛选
*/

returnKey：boolean
/**
 是否返回宜忌key
 defalut: false
 false: 词条将按国际化翻译后返回
 true: 返回宜忌key，（本库宜忌以繁体中文作为key）
*/

replacer?:  { [key: string]: string }
/**
 宜忌词条替换 
 default: undefined
 例如要把“剃頭”替換成"理髮" 可設定為 {剃頭: "理髮"}
*/

theGods.getGoodActs(actType?: 0 | 1 | 2 | 3, returnKey?: boolean, replacer?: {}): string[]

// 參數與getActs相同
// 此方法等同于:
theGods.getActs(actType, returnKey, replacer).good

theGods.getBadActs(actType?: 0 | 1 | 2 | 3, returnKey?: boolean, replacer?: {}): string[]

// 參數與getActs相同
// 此方法等同于:
theGods.getActs(actType, returnKey, replacer).bad

theGods.getAllDayHourGods(): God[][]

// 返回结果为二维数组：
[
  [God, God, ...], // 子时
  [God, God, God, ...], // 丑时
  [God, God, God, ...], // 寅时
  [God, God, ...], // 卯时
  [God, ...], // 辰时
  [God, ...], // 巳时
  ...
  ...
  [God, ...], //亥时
]

theGods.getLuckHours(luckType: 0 | 1 = 1): number[]
// 返回数组表示各时辰，数组元素指示吉凶，大于0为吉，小于0为凶
[1, 1, -1, 1, -1, -1, -1, -1, 1, 1, -1, -1]

luckeType: 0 | 1
/**
选择吉凶取法
default: 0
0: 按黄黑道十二神（即青龙明堂等）决定吉凶
1：按黄黑道十二神（即青龙明堂等）决定吉凶
*/

// 示例：
const lsr = lunisolar('2022-11-25')
const allDirections = lsr.theGods.getAllLuckDirection()
for (let i = 0; i < allDirections.length; i++) {
  const [d24, god] = allDirections[i]
  console.log(d24.direction, god.name)
}
// 南 喜神
// 東南 福神
// 南 財神
// 東 陽貴
// 東南 陰貴

// 示例：
const lsr = lunisolar('2022-11-25')
const [d24, god] = lsr.theGods.getLuckDirection('財神')
console.log(d24.direction) // 南

godKeyOrName:string
/**
吉方神煞名称，一般为 '喜神' | '福神' | '財神' | '陽貴' | '陰貴'
可以是国际化翻译后的名称
不在此范围内者，将返回null
*/

theGod.query(queryString): God | God[] | string[] | null