Faker 2.5.0

Author: Awilum

CHANGELOG.md

@@ -1,3 +1,7 @@
+<a name="2.5.0"></a>
+# [2.5.0](https://github.com/faker-javascript/faker) (2022-01-17)
+* Added new method `paragraph` to generate fake paragraph value.
+
 <a name="2.4.0"></a>
 # [2.4.0](https://github.com/faker-javascript/faker) (2022-01-15)
 * Added new method `sentence` to generate fake sentence value.

index.d.ts

@@ -36,6 +36,11 @@ interface OptionsWord {
 interface OptionsSentence {
     words?: number;
 }
+interface OptionsParagraph {
+    sentences?: number;
+    wordsMin?: number;
+    wordsMax?: number;
+}
 declare class Faker {
     boolean(): boolean;
     integer(options?: OptionsInteger): number;
@@ -50,6 +55,7 @@ declare class Faker {
     superhero(): string;
     word(options?: OptionsWord): string;
     sentence(options?: OptionsSentence): string;
+    paragraph(options?: OptionsParagraph): string;
 }
 declare const faker: Faker;
 export default faker;

index.js

@@ -11,6 +11,7 @@ import profession from '@fakerjs/profession';
 import superhero from '@fakerjs/superhero';
 import word from '@fakerjs/word';
 import sentence from '@fakerjs/sentence';
+import paragraph from '@fakerjs/paragraph';
 
 class Faker {
     boolean() {
@@ -64,6 +65,10 @@ class Faker {
     sentence(options) {
         return sentence(options);
     }
+
+    paragraph(options) {
+        return paragraph(options);
+    }
 }
 
 const faker = new Faker();

index.test-d.ts

@@ -14,3 +14,4 @@ expectType<number>(faker.integer());
 expectType<number>(faker.float());
 expectType<string>(faker.word());
 expectType<string>(faker.sentence());
+expectType<string>(faker.paragraph());

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fakerjs/faker",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "A set of javascript packages that generates fake data for you.",
   "license": "MIT",
   "repository": "faker-javascript/faker",
@@ -47,6 +47,7 @@
     "@fakerjs/profession": "^2",
     "@fakerjs/superhero": "^1",
     "@fakerjs/word": "^1",
-    "@fakerjs/sentence": "^1"
+    "@fakerjs/sentence": "^1",
+    "@fakerjs/paragraph": "^1"
   }
 }

test.js

@@ -56,3 +56,7 @@ test('faker word return type to be string', t => {
 test('faker sentence return type to be string', t => {
     t.is(typeof faker.sentence(), 'string');
 });
+
+test('faker paragraph return type to be string', t => {
+    t.is(typeof faker.paragraph(), 'string');
+});