aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-06-01 23:28:51 +0200
committerGitHub <[email protected]>2023-06-01 23:28:51 +0200
commite4a6bfe7bed44e5b9d6b3c386b776d293bedd956 (patch)
tree50c8ff2f3e3de06f050cf4c2ef9ab6ec49285a8b
parent27a8ff7113895c5e5ee52235db364e0d87fe8a0e (diff)
downloadfaker-e4a6bfe7bed44e5b9d6b3c386b776d293bedd956.tar.xz
faker-e4a6bfe7bed44e5b9d6b3c386b776d293bedd956.zip
chore: fix jsdoc lint error (#2182)
-rw-r--r--.eslintrc.js2
-rw-r--r--src/faker.ts4
2 files changed, 3 insertions, 3 deletions
diff --git a/.eslintrc.js b/.eslintrc.js
index f31091da..2c6e74ec 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -81,7 +81,7 @@ module.exports = defineConfig({
{
files: ['src/**/*.ts'],
plugins: ['jsdoc'],
- extends: ['plugin:jsdoc/recommended'],
+ extends: ['plugin:jsdoc/recommended-error'],
rules: {
'jsdoc/no-types': 'error',
'jsdoc/require-param-type': 'off',
diff --git a/src/faker.ts b/src/faker.ts
index 45ae9816..f227643e 100644
--- a/src/faker.ts
+++ b/src/faker.ts
@@ -151,7 +151,7 @@ export class Faker {
readonly word: WordModule = new WordModule(this);
// Aliases
- /** @deprecated Use {@link location} instead */
+ /** @deprecated Use {@link Faker#location} instead */
get address(): AddressModule {
deprecated({
deprecated: 'faker.address',
@@ -162,7 +162,7 @@ export class Faker {
return this.location;
}
- /** @deprecated Use {@link person} instead */
+ /** @deprecated Use {@link Faker#person} instead */
get name(): NameModule {
deprecated({
deprecated: 'faker.name',