Skip to content

Commit abd4d24

Browse files
authored
docs: mention strict typescript usage (#3171)
1 parent 7141608 commit abd4d24

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/guide/usage.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,17 @@ It is highly recommended to use version tags when importing libraries in Deno, e
9494

9595
## TypeScript Support
9696

97-
Faker supports TypeScript out of the box, so you don't have to install any extra packages.
97+
We assume that you use TypeScript (strict mode).
98+
You can use Faker without it, but we don't have dedicated error messages for wrong parameter types.
9899

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

101102
```json
102103
{
103104
"compilerOptions": {
104105
"esModuleInterop": true,
105-
"moduleResolution": "Bundler" // "Node10", "Node16" or "NodeNext"
106+
"moduleResolution": "Bundler", // "Node10", "Node16" or "NodeNext"
107+
"strict": true // Optional, but recommended
106108
}
107109
}
108110
```

0 commit comments

Comments
 (0)