Update the license date

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

$ npm install zodiac-signs

Example

Importing the module

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

// 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

// 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

// 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 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.

	const regex = new RegExp('^[a-z]{2}(-[A-Z]{2})?$'); // xx-YY

	module.exports = defaultLanguage => {
	// Language format verification
	if (regex.test(defaultLanguage)) { // Language format (xx-YY) verification
	defaultLanguage = defaultLanguage.substring(0, 2);
	} else {
	defaultLanguage = 'en';
	}

	const parseLanguage = language => {
	const regex = new RegExp('^[a-z]{2}(-[A-Z]{2})?$'); // xx-YY

	// Language format (xx-YY) verification
	if (regex.test(language)) {
	language = language.substring(0, 2);
	}

	return language;
	}

helmasaur / zodiac-signs Goto Github PK

zodiac-signs's Introduction

Zodiac-signs

Installation

Example

Importing the module

Getting a zodiac sign from a date

Getting a zodiac sign from a name or symbol

Others

Error management

Translation

Available languages

Thanks

License

zodiac-signs's People

Contributors

Stargazers

Watchers

Forkers

zodiac-signs's Issues

Recommend Projects

Recommend Topics

Recommend Org