Skip to content

Commit

Permalink
docs: browser console usage guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ST-DDT committed May 20, 2024
1 parent 7dc8a18 commit d4ede3d
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions docs/guide/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const randomEmail = faker.internet.email(); // Kassandra.Haley@erich.biz

:::

For more information about changing and customizing the locales, please refer to our [Localization Guide](localization).
For more information on selecting and customizing a locale, please refer to our [Localization Guide](localization).

## Browser

Expand All @@ -46,6 +46,17 @@ For more information about changing and customizing the locales, please refer to
Using the browser is great for experimenting 👍. However, due to all of the strings Faker uses to generate fake data, **Faker is a large package**. It's `> 5 MiB` minified. **Please avoid deploying the full Faker in your web app.**
:::

## Browser Console

If you want to try it yourself, you can open your browser console via `Ctrl + Shift + J` / `F12`.

```js
const { faker } = await import('https://esm.sh/@faker-js/faker');

const randomName = faker.person.fullName(); // Amber Keebler
const randomEmail = faker.internet.email(); // Norma13@hotmail.com
```

## CDN/Deno

```js
Expand All @@ -56,7 +67,7 @@ const randomEmail = faker.internet.email(); // Tomasa_Ferry14@hotmail.com
```

::: info Note
It is highly recommended to use version tags when importing libraries in Deno, e.g: `import { faker } from "https://esm.sh/@faker-js/faker@v8.4.0"`.
It is highly recommended to use version tags when importing libraries in Deno, e.g: `import { faker } from "https://esm.sh/@faker-js/faker@v8.4.1"`.
:::

### Alternative CDN links
Expand Down

0 comments on commit d4ede3d

Please sign in to comment.