Naughty Program Manipulator

    zodiac-signs

    1.1.0 • Public • Published

    License: MIT

    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

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

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

    Available languages

    • English
    • French
    • Russian

    Thanks

    • The Programming Discussion and the Coding Den Discord servers;
    • Micah Akpan for the original package: sign-teller.

    License

    Install

    npm i zodiac-signs

    DownloadsWeekly Downloads

    162

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    16.5 kB

    Total Files

    12

    Last publish

    Collaborators

    • helmasaur