Zodiac-signs

Provides a zodiac sign depending a birthday and much more.

This is based on Micah Akpan's package.

It's for example also possible to get:
- a zodiac's emoji
- a zodiac birthstone

Installation

``bash
$ npm install zodiac-signs
`

Example

$3

`js
const zodiac = require('zodiac-signs')('en');
// Require with a language (format xx-YY sets (format xx))
const zodiac = require('zodiac-signs')('en-US')
// Require without an argument sets 'en'
const zodiac = require('zodiac-signs')();
`

$3

`js
// Returns the zodiac sign's information of the actual day
console.log(zodiac.getSignByDate());
// Returns the zodiac sign's information of the 22 of June
console.log(zodiac.getSignByDate({ day: 22, month: 6 }));
// Overload the default language (format xx-YY sets (format xx))
console.log(zodiac.getSignByDate({ day: 22, month: 6 }, 'fr'));
`


$3

`js
// Returns the Cancer sign's information
console.log(zodiac.getSignByName('cancer');
console.log(zodiac.getSignBySymbol('♋️');
// Overload the default language (format xx-YY sets (format xx))
console.log(zodiac.getSignByName('cancer', 'fr'));
console.log(zodiac.getSignBySymbol('♋️', 'fr');
`

$3

`js
// Returns an array of all zodiac symbols
console.log(zodiac.getSymbols());
// Returns an array of all the zodiac names
console.log(zodiac.getNames());
// Overload the default language (format xx-YY sets (format xx))
console.log(zodiac.getNames('fr'));
``

Error management

An integer is returned if the given parameter is wrong:

| Type | Values | Error code |
|---------|-----------------------------|------------|
| Day* | [1;31] or [1;30] or [1;29] | -1 |
| Month | [1;12] | -1 |
| Name | zodiac signs' names | -2 |
| Symbol | zodiac signs' symbols | -2 |

*Depending on the month, the day's numbers interval can change.

Translation

$3

- English (en)
- Spanish (es)
- French (fr)
- Italian (it)
- Russian (ru)
- Swedish (sv)
- Turkish (tr)

Obviously, you are free to participate to the translation in any other language.

Thanks

- Micah Akpan for the original package: sign-teller;
- The Programming Discussion and the Coding Den Discord servers;
- Martynov Denis for the Russian translation;
- ALİ SİNCAR for the Turkish translation;
- Vito Marseglia for the Italian and Spanish translation;
- Peter Rymdfabriken for the Swedish translation.

License

- My source code is published under MIT License.
- The original package is published under MIT License.