diff --git a/.gitignore b/.gitignore index bac2cd5..46ce66f 100755 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ # Global node_modules/ coverage +package-lock.json # OS Generated .DS_Store* diff --git a/CHANGELOG.md b/CHANGELOG.md index 9a30947..4b34147 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ + +# [2.4.0](https://github.com/faker-javascript/faker) (2022-01-15) +* Added new method `sentence` to generate fake sentence value. + # [2.3.1](https://github.com/faker-javascript/faker) (2022-01-15) * Typo updates. diff --git a/README.md b/README.md index 6a58217..8b9279f 100644 --- a/README.md +++ b/README.md @@ -33,5 +33,5 @@ faker.profession(); [Browse all faker javascript packages](https://github.com/faker-javascript) ## License -[The MIT License (MIT)](https://github.com/faker-javascript/faker/blob/master/LICENSE.txt) +[The MIT License (MIT)](https://github.com/faker-javascript/faker/blob/master/LICENSE) Copyright (c) [Sergey Romanenko](https://github.com/Awilum) diff --git a/index.d.ts b/index.d.ts index e25c8fe..55d9351 100644 --- a/index.d.ts +++ b/index.d.ts @@ -33,6 +33,9 @@ interface OptionsProfession { interface OptionsWord { length?: number; } +interface OptionsSentence { + words?: number; +} declare class Faker { boolean(): boolean; integer(options?: OptionsInteger): number; @@ -46,6 +49,7 @@ declare class Faker { profession(options?: OptionsProfession): string; superhero(): string; word(options?: OptionsWord): string; + sentence(options?: OptionsSentence): string; } declare const faker: Faker; export default faker; diff --git a/index.js b/index.js index c6a87c8..95f2801 100644 --- a/index.js +++ b/index.js @@ -10,6 +10,7 @@ import string from '@fakerjs/string'; import profession from '@fakerjs/profession'; import superhero from '@fakerjs/superhero'; import word from '@fakerjs/word'; +import sentence from '@fakerjs/sentence'; class Faker { boolean() { @@ -59,6 +60,10 @@ class Faker { word(options) { return word(options); } + + sentence(options) { + return sentence(options); + } } const faker = new Faker(); diff --git a/index.test-d.ts b/index.test-d.ts index 6372ccf..6ceea77 100644 --- a/index.test-d.ts +++ b/index.test-d.ts @@ -13,3 +13,4 @@ expectType(faker.superhero()); expectType(faker.integer()); expectType(faker.float()); expectType(faker.word()); +expectType(faker.sentence()); diff --git a/package.json b/package.json index dd7eeb1..058564a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fakerjs/faker", - "version": "2.3.1", + "version": "2.4.0", "description": "A set of javascript packages that generates fake data for you.", "license": "MIT", "repository": "faker-javascript/faker", @@ -46,6 +46,7 @@ "@fakerjs/string": "^2", "@fakerjs/profession": "^2", "@fakerjs/superhero": "^1", - "@fakerjs/word": "^1" + "@fakerjs/word": "^1", + "@fakerjs/sentence": "^1" } } diff --git a/test.js b/test.js index 8a4adce..6ea9432 100644 --- a/test.js +++ b/test.js @@ -52,3 +52,7 @@ test('faker letter return type to be string', t => { test('faker word return type to be string', t => { t.is(typeof faker.word(), 'string'); }); + +test('faker sentence return type to be string', t => { + t.is(typeof faker.sentence(), 'string'); +});