https://github.com/helmasaur/zodiac-signs
Provides a zodiac sign depending a birthday and much more.
https://github.com/helmasaur/zodiac-signs
api astrology birthstone calendar horoscope nodejs nodejs-api sign stone zodiac
Last synced: about 2 months ago
JSON representation
Provides a zodiac sign depending a birthday and much more.
- Host: GitHub
- URL: https://github.com/helmasaur/zodiac-signs
- Owner: helmasaur
- License: mit
- Created: 2020-01-10T04:41:17.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-30T17:42:02.000Z (12 months ago)
- Last Synced: 2025-04-14T09:53:22.369Z (2 months ago)
- Topics: api, astrology, birthstone, calendar, horoscope, nodejs, nodejs-api, sign, stone, zodiac
- Language: JavaScript
- Homepage:
- Size: 62.5 KB
- Stars: 12
- Watchers: 2
- Forks: 11
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/zodiac-signs)
# Zodiac-signs
Provides a zodiac sign depending a birthday and much more.
*This is based on Micah Akpan's [package](https://github.com/micah-akpan/sign-teller).*
It's for example also possible to get:
- a zodiac's emoji
- a zodiac birthstone
## Installation
```bash
$ npm install zodiac-signs
```
## Example
### Importing the module
```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')();
```
### Getting a zodiac sign from a date
```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'));
```
### Getting a zodiac sign from a name or symbol
```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');
```
### Others
```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
### Available languages
- 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](https://github.com/micah-akpan) for the original package: [sign-teller](https://github.com/micah-akpan/sign-teller);
- [The Programming Discussion](https://discord.gg/progdisc) and the [Coding Den](https://discord.gg/code) Discord servers;
- [Martynov Denis](https://github.com/devmartynov) for the Russian translation;
- [ALİ SİNCAR](https://github.com/alisincar) for the Turkish translation;
- [Vito Marseglia](https://github.com/VitoMars) for the Italian and Spanish translation;
- [Peter Rymdfabriken](peter-rymdfabriken) for the Swedish translation.
## License
- My source code is published under [MIT License](https://github.com/Helmasaur/birthgem/blob/master/LICENSE).
- The original package is published under [MIT License](https://github.com/micah-akpan/sign-teller/blob/develop/LICENSE).