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

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

Last synced: 10 days ago
JSON representation

Check if the year is year of pig in Chinese Zodiac

• Host: GitHub
• URL: https://github.com/cht8687/year-of-pig
• Owner: cht8687
• Created: 2016-09-17T03:24:05.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-09-17T23:32:08.000Z (about 8 years ago)
• Last Synced: 2024-11-02T15:06:50.210Z (14 days ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

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

> Check if is year of Pig

## Install

```

$ npm install --save year-of-pig

```

## Usage

```js

const yearOfPig = require('year-of-pig');

yearOfPig(1995);

// true

yearOfPig(1996);

// false

```

## API

### yearOfPig([year])

#### year

Type: `number`  

Default: current year

### yearOfPig([date])

#### date

Type: `date`  

Default: `new Date()`

## License

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