Skip to content

Commit 94013ca

Browse files
committed
feat(packages): add word package
1 parent c093749 commit 94013ca

File tree

5 files changed

+17
-2
lines changed

5 files changed

+17
-2
lines changed

index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ interface OptionsProfession {
3030
rank?: boolean;
3131
locale?: string;
3232
}
33+
interface OptionsWord {
34+
length?: number;
35+
}
3336
declare class Faker {
3437
boolean(): boolean;
3538
integer(options?: OptionsInteger): number;
@@ -42,6 +45,7 @@ declare class Faker {
4245
string(options?: OptionsString): string;
4346
profession(options?: OptionsProfession): string;
4447
superhero(): string;
48+
word(options?: OptionsWord): string;
4549
}
4650
declare const faker: Faker;
4751
export default faker;

index.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import letter from '@fakerjs/letter';
99
import string from '@fakerjs/string';
1010
import profession from '@fakerjs/profession';
1111
import superhero from '@fakerjs/superhero';
12+
import word from '@fakerjs/word';
1213

1314
class Faker {
1415
boolean() {
@@ -54,6 +55,10 @@ class Faker {
5455
superhero() {
5556
return superhero();
5657
}
58+
59+
word(options) {
60+
return word(options);
61+
}
5762
}
5863

5964
const faker = new Faker();

index.test-d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ expectType<string>(faker.ip());
1212
expectType<string>(faker.superhero());
1313
expectType<number>(faker.integer());
1414
expectType<number>(faker.float());
15+
expectType<string>(faker.word());

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@fakerjs/faker",
3-
"version": "2.2.0",
3+
"version": "2.3.0",
44
"description": "A set of javascript packages that generates fake data for you.",
55
"license": "MIT",
66
"repository": "faker-javascript/faker",
@@ -45,6 +45,7 @@
4545
"@fakerjs/letter": "^2",
4646
"@fakerjs/string": "^2",
4747
"@fakerjs/profession": "^2",
48-
"@fakerjs/superhero": "^1"
48+
"@fakerjs/superhero": "^1",
49+
"@fakerjs/word": "^1"
4950
}
5051
}

test.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,7 @@ test('faker ip return type to be string', t => {
4848
test('faker letter return type to be string', t => {
4949
t.is(typeof faker.letter(), 'string');
5050
});
51+
52+
test('faker word return type to be string', t => {
53+
t.is(typeof faker.word(), 'string');
54+
});

0 commit comments

Comments
 (0)