Skip to content

Commit

Permalink
docs: add ts import example in readme (#719)
Browse files Browse the repository at this point in the history
  • Loading branch information
pkuczynski authored Mar 30, 2022
1 parent 7afd8c5 commit f285dc9
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ pnpm install @faker-js/faker -D

```js
const { faker } = require('@faker-js/faker');

const randomName = faker.name.findName(); // Rowan Nikolaus
const randomEmail = faker.internet.email(); // [email protected]
const randomPhoneNumber = faker.phone.phoneNumber(); // (279) 329-8663 x30233
Expand Down Expand Up @@ -95,6 +96,12 @@ In order to have faker working properly, you need to check if these `compilerOpt
}
```

And then simply import it like everything else:

```ts
import { faker } from '@faker-js/faker';
```

If you want for whatever reason the versions prior to `v6`,
you can use `@types/faker` and rebind the declarations to the `@faker-js/faker` package with a `faker.d.ts` file in your e.g. src folder.

Expand Down

0 comments on commit f285dc9

Please sign in to comment.