aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSuyash Gulati <[email protected]>2024-10-13 04:23:36 +0530
committerGitHub <[email protected]>2024-10-12 22:53:36 +0000
commit34cf3643bee275f23bc7a39376c1b3d542a8c45f (patch)
tree712ee3ca0530f2291b9a95cb3d690207ea128db1 /docs
parente271d4a545dd48e57285019e4f412358c49cad0d (diff)
downloadfaker-34cf3643bee275f23bc7a39376c1b3d542a8c45f.tar.xz
faker-34cf3643bee275f23bc7a39376c1b3d542a8c45f.zip
refactor(internet): rename userName method to username (#3130)
Diffstat (limited to 'docs')
-rw-r--r--docs/api/ApiIndex.vue7
-rw-r--r--docs/guide/frameworks.md4
2 files changed, 8 insertions, 3 deletions
diff --git a/docs/api/ApiIndex.vue b/docs/api/ApiIndex.vue
index 7b1be7bf..94085371 100644
--- a/docs/api/ApiIndex.vue
+++ b/docs/api/ApiIndex.vue
@@ -69,8 +69,13 @@ const filtered = computed(() => {
</h3>
<ul>
<li v-for="h of item.headers" :key="h.anchor">
+ <!-- TODO @ST-DDT 2024-09-25: Remove this in v10 -->
<a
- :href="item.link + '#' + slugify(h.anchor)"
+ :href="
+ item.link +
+ '#' +
+ (h.anchor === 'userName' ? 'username-1' : slugify(h.anchor))
+ "
:class="{ deprecated: h.deprecated }"
>{{ h.text }}</a
>
diff --git a/docs/guide/frameworks.md b/docs/guide/frameworks.md
index 3b0cd6f3..1733b4e1 100644
--- a/docs/guide/frameworks.md
+++ b/docs/guide/frameworks.md
@@ -71,7 +71,7 @@ import { faker } from '@faker-js/faker/locale/en';
describe('Testing the application', () => {
it('should create an account with username and password', () => {
- let username = faker.internet.userName();
+ let username = faker.internet.username(); // before version 9.1.0, use userName()
let password = faker.internet.password();
let email = faker.internet.exampleEmail();
@@ -111,7 +111,7 @@ test.describe('Testing the application', () => {
test('should create an account with username and password', async ({
page,
}) => {
- const username = faker.internet.userName();
+ const username = faker.internet.username(); // before version 9.1.0, use userName()
const password = faker.internet.password();
const email = faker.internet.exampleEmail();