Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cht8687/year-of-rooster

Check if the year is year of rooster in Chinese Zodiac
https://github.com/cht8687/year-of-rooster

Last synced: 10 days ago
JSON representation

Check if the year is year of rooster in Chinese Zodiac

Awesome Lists containing this project

README

        

# year-of-rooster [![Build Status](https://travis-ci.org/cht8687/year-of-rooster.svg?branch=master)](https://travis-ci.org/cht8687/year-of-rooster)

> Check if is year of Rooster

## Install

```
$ npm install --save year-of-rooster
```

## Usage

```js

const yearOfRooster = require('year-of-rooster');

yearOfRooster(1993);
// true

yearOfRooster(1994);
// false

```
## API

### yearOfRooster([year])

#### year

Type: `number`
Default: current year

### yearOfRooster([date])

#### date

Type: `date`
Default: `new Date()`

## License

MIT © [haotian Chang](https://github.com/cht8687)