https://github.com/casprwang/chinese-year
get the zodiac animal name of a year
https://github.com/casprwang/chinese-year
animal animals chinese npm npm-package zodiac
Last synced: about 2 months ago
JSON representation
get the zodiac animal name of a year
- Host: GitHub
- URL: https://github.com/casprwang/chinese-year
- Owner: casprwang
- License: mit
- Created: 2017-07-14T23:58:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-07T23:28:19.000Z (about 8 years ago)
- Last Synced: 2025-08-23T19:47:07.955Z (about 2 months ago)
- Topics: animal, animals, chinese, npm, npm-package, zodiac
- Language: JavaScript
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# chinese-year [](https://travis-ci.org/wangsongiam/chinese-year)
> get the zodiac animal name of a certain year
## Install
```
npm install --save chinese-year
```
## Usage
```js
const chineseYear = require('chinese-year')
chineseYear.years
//=> ['Rat', 'Ox', ...]
chineseYear.getAnimal(2000)
//=> 'Dragon'
```
## API
### .getAnimal(year: number):string
### .year:array
get zodiac animal name of a year number
## License
MIT © [Song Wang](https://songwang.io)