iztro - npm Package Compare versions

Comparing version 2.0.4 to 2.0.5

CHANGELOG.md

@@ -10,2 +10,16 @@ # 紫微斗数
 
+## v2.0.5
+
+- ✨ 改进（enhancement）
+
+  🇨🇳
+
+  - 废弃 `astrolabeByLunarDate` 和 `astrolabeBySolarDate` 方法
+  - 增加umd编译以便支持纯js库CDN调用 #87
+
+  🇺🇸
+
+  - deprecate `astrolabeByLunarDate` and `astrolabeBySolarDate` function
+  - add UMD lib to support pure js invoking #87
+
 ## v2.0.4
@@ -12,0 +26,0 @@

lib/astro/astro.d.ts

@@ -7,2 +7,4 @@ import { Language } from '../data/types';
  *
+ * @deprecated 此方法已在`v2.0.5`废弃，请用 `bySolar` 方法替换，参数不变
+ *
  * @param solarDateStr 阳历日期【YYYY-M-D】
@@ -17,4 +19,17 @@ * @param timeIndex 出生时辰序号【0~12】
 /**
+ * 通过阳历获取星盘信息
+ *
+ * @param solarDateStr 阳历日期【YYYY-M-D】
+ * @param timeIndex 出生时辰序号【0~12】
+ * @param gender 性别【男|女】
+ * @param fixLeap 是否调整闰月情况【默认 true】，假入调整闰月，则闰月的前半个月算上个月，后半个月算下个月
+ * @param language 输出语言
+ * @returns 星盘信息
+ */
+export declare const bySolar: (solarDateStr: string, timeIndex: number, gender: GenderName, fixLeap?: boolean, language?: Language) => FunctionalAstrolabe;
+/**
  * 通过农历获取星盘信息
  *
+ * @deprecated 此方法已在`v2.0.5`废弃，请用 `byLunar` 方法替换，参数不变
+ *
  * @param lunarDateStr 农历日期【YYYY-M-D】，例如2000年七月十七则传入 2000-7-17
@@ -30,2 +45,14 @@ * @param timeIndex 出生时辰序号【0~12】
 /**
+ * 通过农历获取星盘信息
+ *
+ * @param lunarDateStr 农历日期【YYYY-M-D】，例如2000年七月十七则传入 2000-7-17
+ * @param timeIndex 出生时辰序号【0~12】
+ * @param gender 性别【男|女】
+ * @param isLeapMonth 是否闰月【默认 false】，当实际月份没有闰月时该参数不生效
+ * @param fixLeap 是否调整闰月情况【默认 true】，假入调整闰月，则闰月的前半个月算上个月，后半个月算下个月
+ * @param language 输出语言
+ * @returns 星盘数据
+ */
+export declare const byLunar: (lunarDateStr: string, timeIndex: number, gender: GenderName, isLeapMonth?: boolean, fixLeap?: boolean, language?: Language) => FunctionalAstrolabe;
+/**
  * 通过公历获取十二生肖
@@ -32,0 +59,0 @@ *

lib/astro/astro.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMajorStarByLunarDate = exports.getMajorStarBySolarDate = exports.getSignByLunarDate = exports.getSignBySolarDate = exports.getZodiacByLunarYear = exports.getZodiacBySolarDate = exports.astrolabeByLunarDate = exports.astrolabeBySolarDate = void 0;
+exports.getMajorStarByLunarDate = exports.getMajorStarBySolarDate = exports.getSignByLunarDate = exports.getSignBySolarDate = exports.getZodiacByLunarYear = exports.getZodiacBySolarDate = exports.byLunar = exports.astrolabeByLunarDate = exports.bySolar = exports.astrolabeBySolarDate = void 0;
 var lunar_lite_1 = require("lunar-lite");
@@ -19,2 +19,4 @@ var data_1 = require("../data");
  *
+ * @deprecated 此方法已在`v2.0.5`废弃，请用 `bySolar` 方法替换，参数不变
+ *
  * @param solarDateStr 阳历日期【YYYY-M-D】
@@ -29,2 +31,17 @@ * @param timeIndex 出生时辰序号【0~12】
     if (fixLeap === void 0) { fixLeap = true; }
+    return (0, exports.bySolar)(solarDateStr, timeIndex, gender, fixLeap, language);
+};
+exports.astrolabeBySolarDate = astrolabeBySolarDate;
+/**
+ * 通过阳历获取星盘信息
+ *
+ * @param solarDateStr 阳历日期【YYYY-M-D】
+ * @param timeIndex 出生时辰序号【0~12】
+ * @param gender 性别【男|女】
+ * @param fixLeap 是否调整闰月情况【默认 true】，假入调整闰月，则闰月的前半个月算上个月，后半个月算下个月
+ * @param language 输出语言
+ * @returns 星盘信息
+ */
+var bySolar = function (solarDateStr, timeIndex, gender, fixLeap, language) {
+    if (fixLeap === void 0) { fixLeap = true; }
     language && (0, i18n_1.setLanguage)(language);
@@ -88,6 +105,8 @@ var palaces = [];
 };
-exports.astrolabeBySolarDate = astrolabeBySolarDate;
+exports.bySolar = bySolar;
 /**
  * 通过农历获取星盘信息
  *
+ * @deprecated 此方法已在`v2.0.5`废弃，请用 `byLunar` 方法替换，参数不变
+ *
  * @param lunarDateStr 农历日期【YYYY-M-D】，例如2000年七月十七则传入 2000-7-17
@@ -104,7 +123,24 @@ * @param timeIndex 出生时辰序号【0~12】
     if (fixLeap === void 0) { fixLeap = true; }
-    var solarDate = (0, lunar_lite_1.lunar2solar)(lunarDateStr, isLeapMonth);
-    return (0, exports.astrolabeBySolarDate)(solarDate.toString(), timeIndex, gender, fixLeap, language);
+    return (0, exports.byLunar)(lunarDateStr, timeIndex, gender, isLeapMonth, fixLeap, language);
 };
 exports.astrolabeByLunarDate = astrolabeByLunarDate;
 /**
+ * 通过农历获取星盘信息
+ *
+ * @param lunarDateStr 农历日期【YYYY-M-D】，例如2000年七月十七则传入 2000-7-17
+ * @param timeIndex 出生时辰序号【0~12】
+ * @param gender 性别【男|女】
+ * @param isLeapMonth 是否闰月【默认 false】，当实际月份没有闰月时该参数不生效
+ * @param fixLeap 是否调整闰月情况【默认 true】，假入调整闰月，则闰月的前半个月算上个月，后半个月算下个月
+ * @param language 输出语言
+ * @returns 星盘数据
+ */
+var byLunar = function (lunarDateStr, timeIndex, gender, isLeapMonth, fixLeap, language) {
+    if (isLeapMonth === void 0) { isLeapMonth = false; }
+    if (fixLeap === void 0) { fixLeap = true; }
+    var solarDate = (0, lunar_lite_1.lunar2solar)(lunarDateStr, isLeapMonth);
+    return (0, exports.bySolar)(solarDate.toString(), timeIndex, gender, fixLeap, language);
+};
+exports.byLunar = byLunar;
+/**
  * 通过公历获取十二生肖
@@ -111,0 +147,0 @@ *

package.json

 {
   "name": "iztro",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "轻量级紫微斗数星盘生成库。可以通过出生年月日获取到紫微斗数星盘信息、生肖、星座等信息。A lightweight kit to astrolabe generator of The Purple Star Astrology (Zi Wei Dou Shu). The Purple Star Astrology(Zi Wei Dou Shu) is a Chinese ancient astrology. You're able to get your horoscope and personality from the astrolabe",
@@ -14,10 +14,12 @@ "main": "lib/index.js",
     "test": "jest --config jestconfig.json --coverage",
-    "prepare": "npm run build",
-    "prepublishOnly": "npm test && npm run lint",
-    "preversion": "npm run lint",
-    "version": "npm run format && git add -A src",
-    "postversion": "git push && git push --tags"
+    "prepare": "yarn build",
+    "prepublishOnly": "npm test && yarn lint",
+    "preversion": "yarn lint",
+    "version": "yarn format && git add -A src",
+    "postversion": "git push && git push --tags",
+    "pub": "yarn build:umd && yarn publish"
   },
   "files": [
-    "lib/**/*"
+    "lib/**/*",
+    "dist/**/*"
   ],
@@ -24,0 +26,0 @@ "publishConfig": {

README-en_US.md

@@ -120,6 +120,6 @@ <div align="center">
   // get astrolabe data by solar date
-  const astrolabe = astro.astrolabeBySolarDate('2000-8-16', 2, 'male', true, 'en-US');
+  const astrolabe = astro.bySolar('2000-8-16', 2, 'male', true, 'en-US');
 
   // get astrolabe data by lunar date
-  const astrolabe = astro.astrolabeByLunarDate('2000-7-17', 2, 'male', false, true, 'en-US');
+  const astrolabe = astro.byLunar('2000-7-17', 2, 'male', false, true, 'en-US');
   ```
@@ -133,6 +133,6 @@
   // get astrolabe data by solar date
-  var astrolabe = iztro.astro.astrolabeBySolarDate('2000-8-16', 2, 'male', true, 'en-US');
+  var astrolabe = iztro.astro.bySolar('2000-8-16', 2, 'male', true, 'en-US');
 
   // get astrolabe data by lunar date
-  var astrolabe = iztro.astro.astrolabeByLunarDate('2000-7-17', 2, 'male', false, true, 'en-US');
+  var astrolabe = iztro.astro.byLunar('2000-7-17', 2, 'male', false, true, 'en-US');
   ```
@@ -139,0 +139,0 @@

README-zh_TW.md

@@ -121,6 +121,6 @@ <div align="center">
   // 通過陽歷獲取星盤信息
-  const astrolabe = astro.astrolabeBySolarDate('2000-8-16', 2, '女', true, 'zh-CN');
+  const astrolabe = astro.bySolar('2000-8-16', 2, '女', true, 'zh-CN');
 
   // 通過農歷獲取星盤信息
-  const astrolabe = astro.astrolabeByLunarDate('2000-7-17', 2, '女', false, true, 'zh-CN');
+  const astrolabe = astro.byLunar('2000-7-17', 2, '女', false, true, 'zh-CN');
   ```
@@ -134,6 +134,6 @@
   // 通過陽歷獲取星盤信息
-  var astrolabe = iztro.astro.astrolabeBySolarDate('2000-8-16', 2, '女', true, 'zh-CN');
+  var astrolabe = iztro.astro.bySolar('2000-8-16', 2, '女', true, 'zh-CN');
 
   // 通過農歷獲取星盤信息
-  var astrolabe = iztro.astro.astrolabeByLunarDate('2000-7-17', 2, '女', false, true, 'zh-CN');
+  var astrolabe = iztro.astro.byLunar('2000-7-17', 2, '女', false, true, 'zh-CN');
   ```
@@ -140,0 +140,0 @@

README.md

@@ -127,3 +127,3 @@ <div align="center">
 
-将 `iztro-{version}.min.js` 用script标签引入html文件使用。
+将 `iztro.min.js` 用script标签引入html文件使用。
 
@@ -139,3 +139,3 @@ ```html
   <body>
-    <script src="./iztro-2.0.4.min.js"></script>
+    <script src="./iztro.min.js"></script>
     <script>
@@ -162,6 +162,6 @@ // 获取一张星盘数据
   // 通过阳历获取星盘信息
-  const astrolabe = astro.astrolabeBySolarDate('2000-8-16', 2, '女', true, 'zh-CN');
+  const astrolabe = astro.bySolar('2000-8-16', 2, '女', true, 'zh-CN');
 
   // 通过农历获取星盘信息
-  const astrolabe = astro.astrolabeByLunarDate('2000-7-17', 2, '女', false, true, 'zh-CN');
+  const astrolabe = astro.byLunar('2000-7-17', 2, '女', false, true, 'zh-CN');
   ```
@@ -175,6 +175,6 @@
   // 通过阳历获取星盘信息
-  var astrolabe = iztro.astro.astrolabeBySolarDate('2000-8-16', 2, '女', true, 'zh-CN');
+  var astrolabe = iztro.astro.bySolar('2000-8-16', 2, '女', true, 'zh-CN');
 
   // 通过农历获取星盘信息
-  var astrolabe = iztro.astro.astrolabeByLunarDate('2000-7-17', 2, '女', false, true, 'zh-CN');
+  var astrolabe = iztro.astro.byLunar('2000-7-17', 2, '女', false, true, 'zh-CN');
   ```
@@ -181,0 +181,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1101075

increased by136.43%

Number of package files

224

increased by0.9%

Lines of code

12899

increased by5.97%

No dependency changes