fortel-codex.js



This node.js module is a library for some basic codex of Chinese Astrology. It included "陰陽", "五行", "天干", "地支", "生肖".

Project page

- Project Home
- Github
- NPM

Wiki pages for Chinese Astrology:
- 陰陽
- 五行
- 天干
- 地支
- 生肖

------------------------

Install

``bash
$ npm install --save fortel-codex
`

------------------------

Samples

$3

`javascript
const fortelCodex = require('fortel-codex');
const MoonSun = fortelCodex.MoonSun;

var moon = MoonSun.get('陰');
moon = MoonSun.Moon; //or equivalently
console.log('陰:', moon);

var sun = MoonSun.get('陽');
sun = MoonSun.Sun; //or equivalently
console.log('陽:', sun);
`

Console output
`
陰: MoonSun { index: 0, displayName: '陰' }
陽: MoonSun { index: 1, displayName: '陽' }
`

$3

基本五行

`javascript
const Element = fortelCodex.Element;

/ 基本五行 Object /
var gold = Element.Gold;
gold = Element.get('金'); //or equivalently
console.log('金: ', gold);

var wood = Element.Wood;
wood = Element.get('木'); //or equivalently
console.log('木: ', wood);

var earth = Element.Earth;
earth = Element.get('土'); //or equivalently
console.log('土: ', earth);

var water = Element.Water;
water = Element.get('水'); //or equivalently
console.log('水: ', water);

var fire = Element.Fire;
fire = Element.get('火'); //or equivalently
console.log('火: ', fire);
`

Console output
`
金: Element { index: 0, displayName: '金' }
木: Element { index: 1, displayName: '木' }
土: Element { index: 2, displayName: '土' }
水: Element { index: 3, displayName: '水' }
火: Element { index: 4, displayName: '火' }
`

五行關係

`javascript
console.log('五行生剋關係1:');
console.log(金${gold.to(gold).relationship}金);
console.log(金${gold.to(wood).relationship}木);
console.log(金${gold.to(earth).relationship}土);
console.log(金${gold.to(water).relationship}水);
console.log(金${gold.to(fire).relationship}火);

console.log('\n');

console.log('五行生剋關係2:');
console.log(金生${gold.getEnhance().displayName});
console.log(金被${gold.getEnhancedBy().displayName}所生);
console.log(金剋${gold.getSuppress().displayName});
console.log(金被${gold.getSuppressedBy().displayName}所剋);
`

Console output
`
五行生剋關係1:
金同金
金剋木
金被生土
金生水
金被剋火


五行生剋關係2:
金生水
金被土所生
金剋木
金被火所剋
`

$3

Array of Stem object(天干)
`javascript
const fortelCodex = require('fortel-codex');
const Stem = fortelCodex.Stem;

/ 基本天干 Object /
var items = Stem.items; //Array of "天干"
var output = "";
for(let item of items){
output += item.displayName;
}
console.log(output);
`

Console output
`
甲乙丙丁戊己庚辛壬癸
`

Get by index
`javascript
const util = require('util');
const fortelCodex = require('fortel-codex');
const Stem = fortelCodex.Stem;

/ Get 天干 by index /
console.log('0: '+util.inspect(Stem.get(0)));
console.log('1: '+util.inspect(Stem.get(1)));
console.log('......\n');
`

Console output
`
0: Stem {
index: 0,
displayName: '甲',
moonSun: MoonSun { index: 1, displayName: '陽' },
element: Element { index: 1, displayName: '木' } }
1: Stem {
index: 1,
displayName: '乙',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 1, displayName: '木' } }
`

Get by name
`javascript
const util = require('util');
const fortelCodex = require('fortel-codex');
const Stem = fortelCodex.Stem;

/ Get 天干 by display name /
console.log('0: '+util.inspect(Stem.get('甲')));
console.log('1: '+util.inspect(Stem.get('乙')));
console.log('......\n');
`

Console output
`
0: Stem {
index: 0,
displayName: '甲',
moonSun: MoonSun { index: 1, displayName: '陽' },
element: Element { index: 1, displayName: '木' } }
1: Stem {
index: 1,
displayName: '乙',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 1, displayName: '木' } }
`

天干合化
`javascript
/ 天干合化 /
console.log('甲己合化' + Stem.get('甲').getSythesisResult(Stem.get('己')).displayName); //甲己合化土
console.log('乙庚合化' + Stem.get('乙').getSythesisResult(Stem.get('庚')).displayName); //乙庚合化金
console.log('丙辛合化' + Stem.get('丙').getSythesisResult(Stem.get('辛')).displayName); //丙辛合化水
console.log('丁壬合化' + Stem.get('丁').getSythesisResult(Stem.get('壬')).displayName); //丁壬合化木
console.log('戊癸合化' + Stem.get('戊').getSythesisResult(Stem.get('癸')).displayName); //戊癸合化火
`

Console output
`
甲己合化土
乙庚合化金
丙辛合化水
丁壬合化木
戊癸合化火
`

天干相剋
`javascript
/ 天干相剋 /
console.log('甲剋' + Stem.get('甲').getSuppress().displayName);
console.log('戊被' + Stem.get('戊').getSuppressedBy().displayName + '所剋');
`

Console output
`
甲剋戊
戊被甲所剋
`

$3

Array of Branch object(地支)
`javascript
const fortelCodex = require('fortel-codex');
const Branch = fortelCodex.Branch;

/ 基本地支 Object /
var items = Branch.items; //Array of "地支"
var output = "";
for(let item of items){
output += item.displayName;
}
console.log(output);
`

Console output
`
子丑寅卯辰巳午未申酉戌亥
`

Get by index
`javascript
/ Get 地支 by index /
console.log('0: '+util.inspect(Branch.get(0)));
console.log('1: '+util.inspect(Branch.get(1)));
console.log('......\n');
`

Console output
`
0: Branch {
index: 0,
displayName: '子',
moonSun: MoonSun { index: 1, displayName: '陽' },
element: Element { index: 3, displayName: '水' },
baseStem:
Stem {
index: 9,
displayName: '癸',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 3, displayName: '水' } },
collectStem: null,
remainStem: null }
1: Branch {
index: 1,
displayName: '丑',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 2, displayName: '土' },
baseStem:
Stem {
index: 5,
displayName: '己',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 2, displayName: '土' } },
collectStem:
Stem {
index: 7,
displayName: '辛',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 0, displayName: '金' } },
remainStem:
Stem {
index: 9,
displayName: '癸',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 3, displayName: '水' } } }
......
`

Get by name
`javascript
const util = require('util');
const fortelCodex = require('fortel-codex');
const Stem = fortelCodex.Stem;

/ Get 地支 by display name /
console.log('0: '+util.inspect(Stem.get('子')));
console.log('1: '+util.inspect(Stem.get('丑')));
console.log('......\n');
`

Console output
`
0: Branch {
index: 0,
displayName: '子',
moonSun: MoonSun { index: 1, displayName: '陽' },
element: Element { index: 3, displayName: '水' },
baseStem:
Stem {
index: 9,
displayName: '癸',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 3, displayName: '水' } },
collectStem: null,
remainStem: null }
1: Branch {
index: 1,
displayName: '丑',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 2, displayName: '土' },
baseStem:
Stem {
index: 5,
displayName: '己',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 2, displayName: '土' } },
collectStem:
Stem {
index: 7,
displayName: '辛',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 0, displayName: '金' } },
remainStem:
Stem {
index: 9,
displayName: '癸',
moonSun: MoonSun { index: 0, displayName: '陰' },
element: Element { index: 3, displayName: '水' } } }
......
`

地支六合局
`javascript
/ Get 地支六合局 /
let combinations = Branch.checkCombinations([Branch.get('子'), Branch.get('丑')]);
console.log("子丑合化"+combinations.sixSythesis[0].element.displayName);

console.log("寅亥合化"+Branch.checkSixSythesis(Branch.get('寅'), Branch.get('亥')).displayName);
`

Console output
`
子丑合化土
寅亥合化木
`

地支三合局
`javascript
/ Get 地支三合局 /
let combinations = Branch.checkCombinations([Branch.get('申'), Branch.get('子'), Branch.get('辰')]);
console.log("申子辰三合"+combinations.threeSythesis[0].combination.element.displayName+"局");

console.log("寅戌合"+Branch.checkThreeSythesis(Branch.get('寅'), Branch.get('戌')).element.displayName+"局");
`

Console output
`
申子辰三合水局
寅戌合火局
`

地支相沖
`javascript
/ Get 地支相沖 /
console.log(Branch.checkOpposite(Branch.get('子'), Branch.get('午')));
console.log(Branch.checkOpposite(Branch.get('子'), Branch.get('亥')));
`

Console output
`
true
false
`

地支相刑
`javascript
/ Get 地支相刑 /
let combinations = Branch.checkCombinations([Branch.get('寅'), Branch.get('巳'), Branch.get('申')]);
console.log(combinations.punishment[0].type);

combinations = Branch.checkCombinations([Branch.get('午'), Branch.get('午')]);
console.log(combinations.punishment[0].type);
`

Console output
`
無恩之刑
自刑
`

地支相害
`javascript
/ Get 地支相害 /
/ Get 地支相刑 /
console.log(Branch.checkHarm(Branch.get('子'), Branch.get('未')));
console.log(Branch.checkHarm(Branch.get('子'), Branch.get('丑')));
`

Console output
`
true
false
`

$3

Array of BranchHour object(時辰)
`javascript
const fortelCodex = require('fortel-codex');
const BranchHour = fortelCodex.BranchHour;

var items = BranchHour.items; //Array of "時辰"
console.log(items.map(item=>item.displayName).join(', '));
`

Console output
`
早子, 丑, 寅, 卯, 辰, 巳, 午, 未, 申, 酉, 戌, 亥, 晚子
`

$3

Array of Zodiac object(生肖)
`javascript
const fortelCodex = require('fortel-codex');
const Zodiac = fortelCodex.Zodiac;

var items = Zodiac.items; //Array of "生肖"
console.log(items.map(item=>item.displayName).join(', '));
`

Console output
`
鼠, 牛, 虎, 兔, 龍, 蛇, 馬, 羊, 猴, 雞, 狗, 豬
``

------------------------

API

(Will update later)

------------------------

Author Contact

- Eric Yu: airic.yu@gmail.com