Merge branch 'main' into prettier-ignore-temp-files

Author: Shinigami92

docs/guide/index.md

@@ -90,6 +90,38 @@ It is highly recommended to use version tags when importing libraries in Deno, e
 
 - https://cdn.jsdelivr.net/npm/@faker-js/faker
 
+### TypeScript Support
+
+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"
+  }
+}
+```
+
+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.
+
+```ts
+// faker.d.ts
+declare module '@faker-js/faker' {
+  import faker from 'faker';
+  export default faker;
+}
+```
+
 ## Community
 
 If you have questions or need help, reach out to the community via [Discord](https://chat.fakerjs.dev) and [GitHub Discussions](https://github.com/faker-js/faker/discussions).

package.json

@@ -94,18 +94,18 @@
     "@algolia/client-search": "~4.13.0",
     "@types/markdown-it": "~12.2.3",
     "@types/node": "~17.0.31",
-    "@types/prettier": "~2.6.0",
+    "@types/prettier": "~2.6.1",
     "@types/react": "~17.0.45",
     "@types/sanitize-html": "~2.6.2",
     "@types/validator": "~13.7.2",
-    "@typescript-eslint/eslint-plugin": "~5.22.0",
-    "@typescript-eslint/parser": "~5.22.0",
-    "@vitest/ui": "~0.10.5",
+    "@typescript-eslint/eslint-plugin": "~5.23.0",
+    "@typescript-eslint/parser": "~5.23.0",
+    "@vitest/ui": "~0.12.6",
     "c8": "~7.11.2",
     "conventional-changelog-cli": "~2.2.2",
-    "cypress": "~9.6.0",
-    "esbuild": "~0.14.38",
-    "eslint": "~8.14.0",
+    "cypress": "~9.6.1",
+    "esbuild": "~0.14.39",
+    "eslint": "~8.15.0",
     "eslint-config-prettier": "~8.5.0",
     "eslint-define-config": "~1.4.0",
     "eslint-gitignore": "~0.1.0",
@@ -129,9 +129,9 @@
     "typedoc-plugin-missing-exports": "~0.22.6",
     "typescript": "~4.6.4",
     "validator": "~13.7.0",
-    "vite": "~2.9.8",
+    "vite": "~2.9.9",
     "vitepress": "~0.22.4",
-    "vitest": "~0.10.5"
+    "vitest": "~0.12.6"
   },
   "packageManager": "[email protected]",
   "engines": {