iztro

📦 IZTRO

一套轻量级紫微斗数排盘工具库。

---

简体中文 🔸 English

---

介绍

用于紫微斗数排盘的javascript开源库，有以下功能。

• 根据出生日期（农历或阳历）以及出生时辰获取紫微斗数星盘数据，星盘数据包括
  • 基础信息（出生日期，时辰，星座，生肖，身主，命主等信息）
  • 宫位信息（宫位名称，干支，星耀等）
  • 星耀信息（包括亮度【（庙、旺、得、利、平、不、陷）】，四化【禄，权，科，忌】和类型）
  • 运限信息（大限，小限，流年，流月，流日，流时）
  • 星耀四化
• 根据天干获取四化
• 查询指定宫位三方四正宫位
• 查询指定星耀是否存在指定宫位内
• 查询指定星耀是否存在于三方四正内
• 多语言输入/输出结果

快捷跳转

• 开发文档
• 讨论
• 问题

安装依赖

你可以使用任何你熟悉的包管理库来安装iztro

• NPM

  npm install iztro -S
  

• Yarn

  yarn add iztro
  

• pnpm

  pnpm install iztro -S
  

例子

这里是一个简单的例子显示如何调用iztro获取到紫微斗数星盘数据，详细文档请移步开发文档

• ES6 Module

  import { astro } from 'iztro';
  
  // 通过阳历获取星盘信息
  const astrolabe = astro.astrolabeBySolarDate('2000-8-16', 2, '女', true, 'zh-CN');
  
  // 通过农历获取星盘信息
  const astrolabe = astro.astrolabeByLunarDate('2000-7-17', 2, '女', false, true, 'zh-CN');
  

• CommonJS

  var iztro = require('iztro');
  
  // 通过阳历获取星盘信息
  var astrolabe = iztro.astro.astrolabeBySolarDate('2000-8-16', 2, '女', true, 'zh-CN');
  
  // 通过农历获取星盘信息
  var astrolabe = iztro.astro.astrolabeByLunarDate('2000-7-17', 2, '女', false, true, 'zh-CN');
  

贡献指南

如果你对iztro有兴趣，也想加入贡献队伍，我们非常欢迎，你可以用以下方式进行：

• 如果你对程序功能有什么建议，请到这里创建一个功能需求。
• 如果你发现程序有BUG，请到这里创建一个BUG报告。
• 你也可以将本仓库fork到你自己的仓库进行编辑，然后提交PR到本仓库。
• 假如你擅长外语，我们也欢迎你对国际化文件的翻译做出你的贡献，你可以fork本仓库，然后在locales文件夹下创建一个国际化语言文件，然后复制其他语言文件目录里面的文件到你的目录下进行更改。
• 当然，如果在我挑灯码字的时候能的到你赞助的咖啡，在下也是不胜感激👍 Paypal Me

总结

使用本程序返回的数据，你可以生成这样一张星盘，当然这只是一个例子，你可以把注意力集中在星盘的设计上，也可以把重心放在数据的分析上，本程序为你解决了最繁冗的工作，让你可以把精力更多的放在你所需要关注的事情上面。

版权

MIT License

Copyright © 2023 Sylar Long

请合理使用本开源代码，禁止用于非法目的。

Changelog

v1.1.0

• 🪄 功能（feature）

  🇨🇳

  • 实现三方四正宫位功能 #21

  🇺🇸

  • implement surrounded palaces feature #21

• ✨ 改进（enhancement）

  🇨🇳

  • 支持性别国际化
  • 将timely修改为hourly
  • 优化types结构，将types.ts拆分进types文件夹内，方便维护

  🇺🇸

  • localization for gender
  • rename timely to hourly
  • optimize the structure of types: split types.ts into several parts and store them into types directory.