https://github.com/faker-javascript/sport
Sport package provides functionality to generate a fake sport value.
https://github.com/faker-javascript/sport
Last synced: 2 months ago
JSON representation
Sport package provides functionality to generate a fake sport value.
- Host: GitHub
- URL: https://github.com/faker-javascript/sport
- Owner: faker-javascript
- License: mit
- Created: 2022-01-30T21:23:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-03-13T06:46:15.000Z (over 3 years ago)
- Last Synced: 2025-03-11T21:47:36.012Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Sport
Sport package provides functionality to generate a fake sport value.
## Install
npm
```
npm install @fakerjs/sport --save-dev
```
yarn
```
yarn add @fakerjs/sport -D
```
## Usage
```js
import sport from '@fakerjs/sport';
sport({locale: 'en_US'}).unusual();
//=> Apple Racing
// Allowed locale: en_US
sport().unusual();
//=> Apple Racing
sport().ancientOlympics();
//=> Boxing
sport().summerOlympics();
//=> Archery
sport().summerParalympics();
//=> Archery
sport().winterOlympics();
//=> Biathlon
sport().winterParalympics();
//=> Snowboard
```
## Tests
Run tests
```
npm run test
```
## License
[The MIT License (MIT)](https://github.com/faker-javascript/sport/blob/master/LICENSE)
Copyright (c) [Sergey Romanenko](https://github.com/Awilum)