diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d27d84..1b0174e 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ + +# [2.0.0](https://github.com/faker-javascript/animal) (2022-01-09) + +### BREAKING CHANGES + +* New function `animal` istead of `fakeAnimal` + # [1.0.0](https://github.com/faker-javascript/animal) (2022-01-09) * Initial release diff --git a/README.md b/README.md index 0ad6d1d..84aa15e 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,15 @@ $ npm install --save @fakerjs/animal ## Usage ```js -import fakeAnimal from '@fakerjs/animal'; +import animal from '@fakerjs/animal'; -fakeAnimal(); +animal(); //=> Snow Leopard -fakeAnimal({type: 'zoo'}); +animal({type: 'zoo'}); //=> Snow Leopard -fakeAnimal({type: 'zoo', locale: 'en_US'}); +animal({type: 'zoo', locale: 'en_US'}); //=> Snow Leopard // Allowed type: ocean, desert, grassland, forest, farm, pet, zoo diff --git a/index.js b/index.js index c07fdff..90929fd 100644 --- a/index.js +++ b/index.js @@ -1,4 +1,4 @@ -export default function fakeAnimal(options) { +export default function animal(options) { options = options || {}; let animals = { "en_US": { diff --git a/package.json b/package.json index 0337546..b7b537c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fakerjs/animal", - "version": "1.0.0", + "version": "2.0.0", "description": "Animal package provides functionality to generate a fake animal value.", "license": "MIT", "repository": "faker-javascript/animal", @@ -25,6 +25,7 @@ ], "keywords": [ "fakerjs", + "faker", "fake", "random", "animal" diff --git a/test.js b/test.js index e4f19b0..3f4fa6b 100644 --- a/test.js +++ b/test.js @@ -1,10 +1,10 @@ -import fakeProfession from './index.js'; +import animal from './index.js'; import test from 'ava'; -test('fakeAnimal return type to be string', t => { - t.is(typeof fakeProfession(), 'string'); +test('animal return type to be string', t => { + t.is(typeof animal(), 'string'); }); -test('fakeAnimal with type and locale return type to be string', t => { - t.is(typeof fakeProfession({type: 'zoo', locale: 'en_US'}), 'string'); +test('animal with type and locale return type to be string', t => { + t.is(typeof animal({type: 'zoo', locale: 'en_US'}), 'string'); }); \ No newline at end of file