https://github.com/magicdawn/baijiaxing.js

baijiaxing = 百家姓
https://github.com/magicdawn/baijiaxing.js

Last synced: about 1 year ago
JSON representation

baijiaxing = 百家姓

• Host: GitHub
• URL: https://github.com/magicdawn/baijiaxing.js
• Owner: magicdawn
• License: mit
• Created: 2016-09-05T02:29:30.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2020-07-21T12:34:54.000Z (almost 6 years ago)
• Last Synced: 2025-04-20T04:34:20.483Z (about 1 year ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 9
• Watchers: 2
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# baijiaxing

> baijiaxing = 百家姓

[![Build Status](https://img.shields.io/travis/magicdawn/baijiaxing.js.svg?style=flat-square)](https://travis-ci.org/magicdawn/baijiaxing.js)

[![Coverage Status](https://img.shields.io/codecov/c/github/magicdawn/baijiaxing.js.svg?style=flat-square)](https://codecov.io/gh/magicdawn/baijiaxing.js)

[![npm version](https://img.shields.io/npm/v/baijiaxing.svg?style=flat-square)](https://www.npmjs.com/package/baijiaxing)

[![npm downloads](https://img.shields.io/npm/dm/baijiaxing.svg?style=flat-square)](https://www.npmjs.com/package/baijiaxing)

[![npm license](https://img.shields.io/npm/l/baijiaxing.svg?style=flat-square)](http://magicdawn.mit-license.org)

## Install

```sh

$ npm i baijiaxing --save

```

## API

```js

const baijiaxing = require('baijiaxing');

```

### `.get(中文姓名)`

```js

baijiaxing.get('张三').should.equal('zhang');

baijiaxing.get('李四').should.equal('li');

baijiaxing.get('诸葛亮').should.equal('zhu ge');

```

### `.getWithTone(中文姓名)`

```js

baijiaxing.getWithTone('张三').should.equal('zhāng');

baijiaxing.getWithTone('李四').should.equal('lǐ');

baijiaxing.getWithTone('诸葛亮').should.equal('zhū gě');

```

## Changelog

[CHANGELOG.md](CHANGELOG.md)

## License

the MIT License http://magicdawn.mit-license.org