diff options
| author | Shinigami <[email protected]> | 2022-03-01 17:16:55 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-03-01 17:16:55 +0100 |
| commit | 0afdf0309047a3e2da9f3c802930c026536766a9 (patch) | |
| tree | 34823e9d31a916af112c756ab4b1ab87c6878847 /docs | |
| parent | 4eef328a90657ce64a5210862ad372ecd97d7e7a (diff) | |
| download | faker-0afdf0309047a3e2da9f3c802930c026536766a9.tar.xz faker-0afdf0309047a3e2da9f3c802930c026536766a9.zip | |
docs: rewrite tree-shaking part (#549)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/migration-guide-v5/index.md | 42 |
1 files changed, 29 insertions, 13 deletions
diff --git a/docs/migration-guide-v5/index.md b/docs/migration-guide-v5/index.md index 979a5be9..1fcc229f 100644 --- a/docs/migration-guide-v5/index.md +++ b/docs/migration-guide-v5/index.md @@ -36,33 +36,49 @@ Faker now ships with its own types! Remove `@types/faker` from your `package.jso ### Tree-shaking -Faker now supports tree-shaking! We highly recommend that you take advantage of your bundler's tree-shaking capabilities and change how you import Faker. This is especially true if you're importing Faker in the browser. +:::warning +Tree shaking is not yet fully supported due to some structural issues. But we plan to make Faker fully tree-shakable in the future. +::: -Faker is a giant package made up of many megabytes of strings. Only import what you need. +For now Faker supports tree-shaking for some parts, and we highly recommend that you take advantage of your bundler's tree-shaking capabilities and change how you import Faker right now. -:::tip -Migrating to the new tree-shakeable syntax should be quick and painless. -::: +Instead of using: -For JS: +```ts +// js +const faker = require('@faker-js/faker'); -```js +// ts +import faker from '@faker-js/faker'; +``` + +You should switch to: + +```ts +// js const { faker } = require('@faker-js/faker'); -// Or specific locale -const fakerDe = require('@faker-js/faker/locale/de'); +// ts +import { faker } from '@faker-js/faker'; ``` -For TS: +If you only need one specific language, we highly recommend to make use of the locale specific imports like: ```ts -import { faker } from '@faker-js/faker'; +// js +const fakerDe = require('@faker-js/faker/locale/de'); -// Or specific locale +// ts import fakerDe from '@faker-js/faker/locale/de'; ``` -Please [open an issue on GitHub](https://github.com/faker-js/faker/issues/new?assignees=&labels=pending+triage&template=freestyle.md) if we've missed any steps. +This is especially true if you're importing Faker in the browser. + +Faker is a giant package made up of many megabytes of strings. Only import what you need. + +_We plan to load the locales in another way in a future major release._ + +--- Happy Faking! |
