Boolean 2.0.0

faker-javascript · Jan 9, 2022 · 4349f90 · 4349f90
1 parent 79bb6b0
commit 4349f90
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+<a name="2.0.0"></a>
+# [2.0.0](https://github.com/faker-javascript/boolean) (2022-01-09)
+
+### BREAKING CHANGES
+
+* New function `boolean` istead of `fakeBoolean`
+
 <a name="1.1.1"></a>
 # [1.1.1](https://github.com/faker-javascript/boolean) (2022-01-08)
 * Package fixes

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ Boolean package provides functionality to generate a fake boolean value.
 </p>
 
 <p align="center">
-<a href="https://github.com/faker-javascript/boolean/releases"><img alt="Version" src="https://img.shields.io/github/release/faker-javascript/boolean.svg?label=version&color=green"></a> <img src="https://img.shields.io/npm/dt/@fakerjs/boolean"> <a href="https://github.com/faker-javascript/boolean"><img src="https://img.shields.io/badge/license-MIT-blue.svg?color=green" alt="License"></a> <img src="https://github.com/faker-javascript/boolean/actions/workflows/tests.yml/badge.svg">
+<a href="https://github.com/faker-javascript/random-boolean/releases"><img alt="Version" src="https://img.shields.io/github/release/faker-javascript/boolean.svg?label=version&color=green"></a> <img src="https://img.shields.io/npm/dt/@fakerjs/boolean"> <a href="https://github.com/faker-javascript/boolean"><img src="https://img.shields.io/badge/license-MIT-blue.svg?color=green" alt="License"></a> <img src="https://github.com/faker-javascript/boolean/actions/workflows/tests.yml/badge.svg">
 </p>
 
 ## Install
@@ -18,10 +18,10 @@ $ npm install --save @fakerjs/boolean
 ```js
 import fakeBoolean from '@fakerjs/boolean';
 
-fakeBoolean();
+boolean();
 //=> true
 
-fakeBoolean();
+boolean();
 //=> false
 ```
 

diff --git a/index.js b/index.js
@@ -1,3 +1,3 @@
-export default function fakeBoolean() {
+export default function boolean() {
     return Math.random() >= 0.5;
 };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@fakerjs/boolean",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "description": "Boolean package provides functionality to generate a fake boolean value.",
   "license": "MIT",
   "repository": "faker-javascript/boolean",

diff --git a/test.js b/test.js
@@ -1,6 +1,6 @@
-import fakeBoolean from './index.js';
+import boolean from './index.js';
 import test from 'ava';
 
-test('fakeBoolean return type to be boolean', t => {
-	t.is(typeof fakeBoolean(), 'boolean');
+test('boolean return type to be boolean', t => {
+	t.is(typeof boolean(), 'boolean');
 });