README.md

Animal

Animal package provides functionality to generate a fake animal value.

Install

npm

npm install @fakerjs/animal --save-dev

yarn

yarn add @fakerjs/animal -D

Usage

import animal from '@fakerjs/animal';

animal();
//=> Snow Leopard

animal({type: 'zoo'});
//=> Snow Leopard

animal({type: 'zoo', locale: 'en_US'});
//=> Snow Leopard

// Allowed type: ocean, desert, grassland, forest, farm, pet, zoo
// Allowed locale: en_US

Tests

Run tests

npm run test

License

The MIT License (MIT) Copyright (c) Sergey Romanenko