Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add prerequisite for typescript configuration #539

Merged
merged 3 commits into from
Feb 22, 2022
Merged

docs: Add prerequisite for typescript configuration #539

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
847e367
Add prerequisite for typescript configuration
Feb 22, 2022
e4f0553
Update wording in README
Feb 22, 2022
2573aa7
Merge branch 'main' into doc/464-typescript
ST-DDT Feb 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ const randomCard = faker.helpers.createCard(); // random contact card containing

Since version `v6+` there is native TypeScript support.

In order to have faker working properly, you need to check if these `compilerOptions` are set correctly in your `tsconfig` file:

```json
{
"compilerOptions": {
"esModuleInterop": true,
"moduleResolution": "Node"
}
}
```

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