LitoMore / mzsi

:cancer: Discover the zodiac sign and their information.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

My Zodiac Sign Is Build Status Dependency Status Npm Package Version codecov

Discover the zodiac sign and know what their information, such as elements and behavioral characteristics.

♈ ♉ ♊ ♋ ♌ ♍ ♎ ♏ ♐ ♑ ♒ ♓


Install

Via Node.js run the following:

$ npm i mzsi --save

Usage

import mzsi from 'mzsi';

let day = 22,
    month = 8;
    
let sign = mzsi(month, day);

console.log(sign.name); // Leo
console.log(sign.symbol); // ♌
console.log(sign.about.element); // Fire
console.log(sign.about.keywords.strength); // ["confident", "ambitious", "generous", "loyal", "encouraging"]
console.log(sign.about.keywords.weakness); // ["pretentious", "domineering", "melodramatic", "stubborn", "vain"]

API

mzsi(month, day, language)

Returns an object with:

  • name (string) - The name of sign.
  • symbol (unicode char) - The representative symbol.
  • about (object) - The informations of element and characteristics.

Currently, the mzsi has translate with two languages (pt-br, en-us). You can choose via language parameter.

Related

License

MIT © Cauê Alves

About

:cancer: Discover the zodiac sign and their information.

License:MIT License


Languages

Language:JavaScript 100.0%