Improve JSDoc deprecation warning for nonempty

Now it will automatically be marked as deprecated by your IDE.
colinhacks · May 19, 2022 · f75b668 · f75b668
1 parent d506b08
commit f75b668
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/deno/lib/types.ts b/deno/lib/types.ts
@@ -634,8 +634,8 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   }
 
   /**
-   * Deprecated.
-   * Use z.string().min(1) instead.
+   * @deprecated Use z.string().min(1) instead.
+   * @see {@link min}
    */
   nonempty = (message?: errorUtil.ErrMessage) =>
     this.min(1, errorUtil.errToObj(message));

diff --git a/src/types.ts b/src/types.ts
@@ -634,8 +634,8 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   }
 
   /**
-   * Deprecated.
-   * Use z.string().min(1) instead.
+   * @deprecated Use z.string().min(1) instead.
+   * @see {@link min}
    */
   nonempty = (message?: errorUtil.ErrMessage) =>
     this.min(1, errorUtil.errToObj(message));