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

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

Last synced: 10 days ago
JSON representation

Check if the year is year of ox in Chinese Zodiac

Awesome Lists containing this project

README

        

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

> Check if is year of Ox

## Install

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

## Usage

```js

const yearOfOx = require('year-of-ox');

yearOfOx(1985);
// true

yearOfOx(1986);
// false

```
## API

### yearOfOx([year])

#### year

Type: `number`
Default: current year

### yearOfOx([date])

#### date

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

## License

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