Lunisolar类

WaterbesideAbout 5 min

Lunisolar类

属性或方法描述参数返回类型
lunar阴历数据对象Lunar
char8八字对象Char8
markers v2.3.0+日期备注对象(可用于节日、备忘等)Markers
solarTerm返回当前日期的节气对象,如果不是节气,返回nullSolarTerm | null
getSeason()取得当前季节string
getSeasonIndex()以春夏秋冬为顺序取得当前季节索引number
toDate()返回Date对象Date
clone()克隆当前Lunisolar对象Lunisolar
unix()返回以秒为单位的时间戳number
format(formatStr: string)按指定格式格式化时间formatStr: string 时间将以这字符串格式进行格式化,例 'YYYY-MM-DD HH:mm:ss'string
diff(date, unit, float)时间差计算date: number | string | Date | Lunisolar
与当前实例的时间进行比较的时间
unit: string
单位,如 year, lunarYear, month, lunarMonth 等
float: boolean
是否返回浮点数
number
add(value, unit)时间加减value: number 时间加减的值,负数为减
unit: string 加减单位
number
year年份number
month月份 1 ~ 12number
day日期 1 ~ 31number
dayOfWeek周几,0 ~ 6, 0代表周日number
hour小时 0 ~ 23number
minute分 0 ~ 59number
second秒 0 ~ 59number
millis毫秒 0 ~ 999number
utc()转为utc模式Lunisolar
isUTC()检查是否为UTC模式的实例boolean
utcOffset(offset)取得,或设置utc偏移值offset: number | undefined
· 当为undefined时,为取得utc偏移值, 返回单位为分钟的number值
· 当为number类型时,为设置utc偏移值,并把时间转为utc时间,返回一个新的Lunisolar实例。如果设置的offset范围在[-16, 16], 则单位为小时,其它情况为分钟
Lunisolar | number
local()转为本地时间Lunisolar
valueOf()返回Date对象的valueOf(), 即时间戳number
toISOString()返回Date对象的toISOString()string
toUTCString()返回Date对象的toUTCString()string
toString()返回当前 Date对象的toUTCString() + 阴历的格式化后的日期时间: 例“Wed, 24 Aug 2022 14:50:51 GMT (二〇二二年七月廿七亥時)”string

Lunisolar.format() 标识符参考

标识
示例描述
lY二〇二二当年阴历正月初一所在的公历年
lYn2022当年阴历正月初一所在的公历年, 数字形式开示
lM正月-十二月阴历月
lMn1-12阴历月, 以数字形式表示
lD初一阴历日
lDn1 - 30阴历日, 以数字形式表示
lH子 - 亥时辰
lHn1 - 12时辰序号,从1开始
lDn1 - 30阴历日, 以数字形式表示
lL大 | 小阴历月是大月还是小月
cY甲子八字年柱
cYs八字年柱天干
cYb八字年柱地支
cM甲子八字月柱
cMs八字月柱天干
cMb八字月柱地支
cD甲子八字日柱
cDs八字日柱天干
cDb八字日柱地支
cH甲子八字日柱
cHs八字日柱天干
cHb八字日柱地支
cYn >= v2.4.00 - 59八字年柱干支序号 (比cY 多个 n,凡干支相关的,想取序号,在后补个n即可)
cYsn >= v2.4.00 - 9八字年柱天干序号 (比cYs 多个 n)
cYbn >= v2.4.00 - 11八字年柱地支序号 (比cYb 多个 n)
cMn >= v2.4.00 - 59八字月柱干支序号
cMsn >= v2.4.00 - 9八字月柱天干序号
cMbn >= v2.4.00八字月柱地支序号
cDn >= v2.4.00 - 59八字日柱干支序号
cDsn >= v2.4.00 - 9八字日柱天干序号
cDbn >= v2.4.00八字日柱地支序号
cHn >= v2.4.00 - 59八字日柱序号
cHsn >= v2.4.00 - 9八字日柱天干序号
cHbn >= v2.4.00八字日柱地支序号
cZ生肖 (立春换岁,可通过config设置换岁时机)
t1-24节气,从小寒到冬至的序号,从1开始,如果该日不是节气,返回空字符串
T小寒-冬至节气字符串,如果该日不是节气,返回空字符串
YY18年,两位数
YYYY2018年,四位数
M1-12月,从1开始
MM01-12月,两位数字
MMMJan-Dec月,英文缩写
D1-31
DD01-31日,两位数
H0-2324小时
HH00-2324小时,两位数
h1-1212小时
hh01-1212小时,两位数
m0-59分钟
mm00-59分钟,两位数
s0-59
ss00-59秒,两位数
S0-9毫秒(百),一位数
SS00-99毫秒(十),两位数
SSS000-999毫秒,三位数
Z-05:00UTC偏移
ZZ-0500UTC偏移,两位数
AAM / PM上/下午,大写
aam / pm上/下午,小写
dR >= v2.3.01 ~ 5该天的星期几在该月第 多少 次出现
dRr >= 2.3.01 ~ 5该天的星期几在该月倒数第 多少 次出现

Lunisolar.diff() unit可选值参考

单位缩写描述
lunarYearlY阴历年
lunarMonthlM阴历月
lunarDaylD阴历日
lunarHourlH时辰
dayd
monthM月份
yeary
hourh小时
minutem分钟
seconds
millisecondms毫秒

Lunisolar.add() unit可选值参考

单位缩写描述
dayd
monthM月份
yeary
hourh小时
minutem分钟
seconds
millisecondms毫秒