Package Exports

birthgem

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (birthgem) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Birthgem

Determines the birthstones from the given month, day of the week or zodiac sign.

This is based on ekimng's package.

Installation

You have to add this module to your NPM folder.

$ npm install birthgem

Example

Importing the module

const acKeijiban = require('birthgem')('en');
// Require with a language (format xx-YY) sets 'en'(format xx)
const acKeijiban = require('birthgem')('en-US')
// Require without an argument sets 'en'
const acKeijiban = require('birthgem')();

The stone names and zodiac signs names can be displayed in different languages.

Displaying a month birthstone

// 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
console.log(birthgem.month(1, 'fr'));

Displaying a day of the week birthstone

// 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
console.log(birthgem.day(1, 'fr'));

Displaying a zodiac sign birthstone

// Returns the birthstone of the present day
console.log(birthgem.zodiac());
// Returns the birthstone of Monday (values: zodiac signs names and symbols)
console.log(birthgem.zodiac('aries'));
console.log(birthgem.zodiac('♈');
// Overload the default language
console.log(birthgem.zodiac(1, 'fr'));

Error management

An integer is returned if the given parameter is wrong:

Type	Values	Error code
Day	[1;7]	-1
Month	[1;12]	-2
Zodiac	zodiac signs names and symbols	-3

Translation

For the moment, the only avaible languages are English and French.

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

Avaible languages

English
French

Thanks

Thanks to ekimng for the original package: birthstone.

License

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