https://github.com/helmasaur/birthgem
Determine the birthstone from the given month or day.
https://github.com/helmasaur/birthgem
api birth birthday birthstone calendar gem gemstone nodejs nodejs-api stone zodiac
Last synced: about 2 months ago
JSON representation
Determine the birthstone from the given month or day.
- Host: GitHub
- URL: https://github.com/helmasaur/birthgem
- Owner: helmasaur
- License: mit
- Created: 2019-12-09T16:15:42.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-05-09T22:48:27.000Z (about 3 years ago)
- Last Synced: 2025-09-03T11:58:48.586Z (9 months ago)
- Topics: api, birth, birthday, birthstone, calendar, gem, gemstone, nodejs, nodejs-api, stone, zodiac
- Language: JavaScript
- Homepage:
- Size: 89.8 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/birthgem)
# Birthgem
Determines the birthstones from the given month, day of the week or zodiac sign.
*This is based on ekimng's [package](https://github.com/ekimng/birthstone).*
- The stone names and zodiac signs names can be in different languages.
- All results are returned into an array except for error codes which are negative integers.
*Functions dedicated to zodiac signs are deprecated. Use the package [zodiac-signs](https://www.npmjs.com/package/zodiac-signs) instead.*
## Installation
You have to add this module to your npm modules folder.
```bash
$ npm install birthgem
```
## Example
### Importing the module
```js
const birthgem = require('birthgem')('en');
// Require with a language (format xx-YY sets (format xx)
const birthgem = require('birthgem')('en-US')
// Require without an argument sets 'en'
const birthgem = require('birthgem')();
```
### Displaying a month birthstone
```js
// Returns the birthstone of the present month
console.log(birthgem.month());
// Returns the birthstone of January (values: [1;12])
console.log(birthgem.month(1));
// Overload the default language (format xx-YY sets (format xx)
console.log(birthgem.month(1, 'fr'));
```
### Displaying a day of the week birthstone
```js
// Returns the birthstone of the present day
console.log(birthgem.day());
// Returns the birthstone of Monday (values: [1;7])
console.log(birthgem.day(1));
// Overloads the default language (format xx-YY sets (format xx)
console.log(birthgem.day(1, 'fr'));
```
### Displaying a zodiac sign birthstone
*Those functions have been removed. Use the package [zodiac-signs](https://www.npmjs.com/package/zodiac-signs) instead.*
## Error management
An integer is returned if the given parameter is wrong:
| Type | Values | Error code |
|--------|--------------------------------|------------|
| Day | [1;7] | -1 |
| Month | [1;12] | -2 |
## Translation
You are free to participate to the translation in any other language.
### Avaible languages
- English
- French
- German
- Italian
- Portuguese
- Spanish
## Thanks
Thanks to ekimng for the original package: [birthstone](https://github.com/ekimng/birthstone).
## 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/ekimng/birthstone/blob/master/LICENSE).