liuyao 0.1.0 → 0.1.1

package/README.md

@@ -6,11 +6,11 @@ For more packages, see [my homepage](https://baendlorel.github.io/?repoType=npm)
 
 ## Features
 
-- Create a yao from its yang-count representation.
-- Build a hexagram from six yao lines or from a known hexagram name.
+- Create a yao from its Yang-count representation, quaternary or various arguments.
+- Build a hexagram from six Yao lines or from a known hexagram name.
 - Inspect hexagram metadata such as its name, palace, phase, and setup information.
 - Derive the changed hexagram for dynamic lines.
-- Access six-god ordering data for different heavenly stems.
+- Access Six God ordering data for different heavenly stems.
 
 ## Installation
 
@@ -23,16 +23,9 @@ pnpm add liuyao
 ```ts
 import { Hexagram, Yao, SixGodList } from 'liuyao';
 
-const hexagram = Hexagram.fromYaos([
-	new Yao(3),
-	new Yao(1),
-	new Yao(2),
-	new Yao(2),
-	new Yao(1),
-	new Yao(0),
-]);
+const hexagram = Hexagram.fromQuaternary('111222'); // gets a Hexagram instance of '地天泰'
 
-if (!hexagram) {
+if (hexagram === null) {
 	throw new Error('Invalid hexagram');
 }
 
@@ -101,11 +94,19 @@ Useful factory methods:
 
 The package currently exports:
 
+**Classes:**
 - `Hexagram`
 - `Yao`
-- `YaoIndex`
-- `SixGodList`
+
+**Data Lists:**
+- `HexagramList`(六十四卦): Includes 64 static hexagram info objects with traditional metadata.
+- `HexagramYaoIndex`(六十四卦爻位名)
+- `TrigramList`(八卦): Includes 8 static trigram info objects with traditional metadata.
+- `SixGodList`(六神表)
+
+**Types:**
 - type `SixGod`
+- type `SixGodInfo`
 - type `SetupGramInfo`
 
 ## Notes

package/dist/index.d.ts

@@ -30,7 +30,7 @@ interface PalaceIndexName {
     name: string;
     nameEn: string;
 }
-declare const PalaceIndexList: PalaceIndexName[];
+declare const PalaceIndexTable: PalaceIndexName[];
 interface HexagramInfo {
     /**
      * Binary representation of the hexagram, where 0 represents a yin line and 1 represents a yang line. The lines are ordered from the bottom (first line) to the top (sixth line).
@@ -82,7 +82,7 @@ interface HexagramInfo {
      */
     setupInfo: [SetupGramInfo, SetupGramInfo, SetupGramInfo, SetupGramInfo, SetupGramInfo, SetupGramInfo];
 }
-declare const HexagramList: readonly HexagramInfo[];
+declare const HexagramInfoTable: readonly HexagramInfo[];
 interface TrigramInfo {
     /**
      * Presents the trigram as a 3-digit binary string. 1 represents a Yang line and 0 represents a Yin line.
@@ -118,7 +118,7 @@ interface TrigramInfo {
 /**
  * List of all trigrams in the I Ching, with their binary representation, number of yang lines, name, what they represent, and their corresponding sign.
  */
-declare const TrigramList: readonly TrigramInfo[];
+declare const TrigramInfoTable: readonly TrigramInfo[];
 
 type SixGod = '玄武' | '白虎' | '螣蛇' | '勾陈' | '朱雀' | '青龙';
 interface SixGodInfo {
@@ -145,7 +145,7 @@ interface SixGodInfo {
 /**
  * @see 《增删卜易·六神章》
  */
-declare const SixGodList: readonly SixGodInfo[];
+declare const SixGodTable: readonly SixGodInfo[];
 
 declare class Yao {
     static getName(yangCount: number): "老阴" | "少阳" | "少阴" | "老阳";
@@ -226,7 +226,7 @@ declare class Yao {
 }
 
 type LiuYao = [Yao, Yao, Yao, Yao, Yao, Yao];
-declare const YaoIndex: readonly ["初爻", "二爻", "三爻", "四爻", "五爻", "上爻"];
+declare const HexagramYaoIndex: readonly ["初爻", "二爻", "三爻", "四爻", "五爻", "上爻"];
 /**
  * Hexagram class represents a hexagram, which consists of 6 Yao.
  * - Each Yao can be either yin or yang, and can be changing or not.
@@ -237,7 +237,7 @@ declare class Hexagram {
     /**
      * Use tokens like `'012132'` to create a Hexagram, where each digit represents the count of Yang in the corresponding Yao (0 for 老阴, 1 for 少阳, 2 for 少阴, 3 for 老阳). The first digit represents the first Yao (初爻) and the last digit represents the sixth Yao (上爻).
      */
-    static fromBinary(quaternary: string): Hexagram | null;
+    static fromQuaternary(quaternary: string): Hexagram | null;
     /**
      * Use tokens like `'单单拆拆重重'` to create a Hexagram.
      *
@@ -298,5 +298,5 @@ declare class Hexagram {
     [Symbol.toPrimitive](hint: string): string;
 }
 
-export { Hexagram, HexagramList, PalaceIndexList, SixGodList, TrigramList, Yao, YaoIndex };
+export { Hexagram, HexagramInfoTable, HexagramYaoIndex, PalaceIndexTable, SixGodTable, TrigramInfoTable, Yao };
 export type { HexagramInfo, SetupGramInfo, SixGod, SixGodInfo, TrigramInfo };

package/dist/index.mjs

@@ -1655,7 +1655,7 @@ class h {
 const r = [ "初爻", "二爻", "三爻", "四爻", "五爻", "上爻" ];
 
 class l {
-  static fromBinary(n) {
+  static fromQuaternary(n) {
     const i = n.split("").map(h.fromDigitString);
     return i.every(n => null !== n) ? new l(i) : null;
   }
@@ -1728,4 +1728,4 @@ class l {
   }
 }
 
-export { l as Hexagram, i as HexagramList, n as PalaceIndexList, s as SixGodList, e as TrigramList, h as Yao, r as YaoIndex };
+export { l as Hexagram, i as HexagramInfoTable, r as HexagramYaoIndex, n as PalaceIndexTable, s as SixGodTable, e as TrigramInfoTable, h as Yao };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "liuyao",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": {
     "name": "Kasukabe Tsumugi",
     "email": "futami16237@gmail.com"
@@ -38,4 +38,4 @@
     "url": "https://github.com/baendlorel/kt-packages/issues"
   },
   "homepage": "https://github.com/baendlorel/kt-packages/tree/main/packages/liuyao#readme"
-}
+}