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

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

Last synced: 10 days ago
JSON representation

Check if the year is year of dragon in Chinese Zodiac

Awesome Lists containing this project

README

        

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

> Check if is year of Dragon

## Install

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

## Usage

```js

const yearOfDragon = require('year-of-dragon');

yearOfDragon(1988);
// true

yearOfDragon(1989);
// false

```
## API

### yearOfDragon([year])

#### year

Type: `number`
Default: current year

### yearOfDragon([date])

#### date

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

## License

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