fix: update jsdoc for default value

danielwaltz · Dec 14, 2024 · 5b85be2 · 5b85be2
1 parent 6a175a9
commit 5b85be2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -43,43 +43,43 @@ codegen({
   /**
    * Run codegen on server start.
    *
-   * @defaultValue `true`
+   * @default true
    */
   runOnStart: boolean,
   /**
    * Run codegen on build. Will prevent build if codegen fails.
    *
-   * @defaultValue `true`
+   * @default true
    */
   runOnBuild: boolean,
   /**
    * Enable codegen integration with vite file watcher.
    *
-   * @defaultValue `true`
+   * @default true
    */
   enableWatcher: boolean,
   /**
    * Throw an error if codegen fails on server start.
    *
-   * @defaultValue `false`
+   * @default false
    */
   throwOnStart: boolean,
   /**
    * Throw an error if codegen fails on build.
    *
-   * @defaultValue `true`
+   * @default true
    */
   throwOnBuild: boolean,
   /**
    * Run codegen when a document matches.
    *
-   * @defaultValue `true`
+   * @default true
    */
   matchOnDocuments: boolean,
   /**
    * Run codegen when a schema matches.
    *
-   * @defaultValue `false`
+   * @default false
    */
   matchOnSchemas: boolean,
   /**
@@ -109,7 +109,7 @@ codegen({
   /**
    * Log various steps to aid in tracking down bugs.
    *
-   * @defaultValue `false`
+   * @default false
    */
   debug: boolean,
 });

diff --git a/src/index.ts b/src/index.ts
@@ -15,43 +15,43 @@ export interface Options {
   /**
    * Run codegen on server start.
    *
-   * @defaultValue `true`
+   * @default true
    */
   runOnStart?: boolean;
   /**
    * Run codegen on build. Will prevent build if codegen fails.
    *
-   * @defaultValue `true`
+   * @default true
    */
   runOnBuild?: boolean;
   /**
    * Enable codegen integration with vite file watcher.
    *
-   * @defaultValue `true`
+   * @default true
    */
   enableWatcher?: boolean;
   /**
    * Throw an error if codegen fails on server start.
    *
-   * @defaultValue `false`
+   * @default false
    */
   throwOnStart?: boolean;
   /**
    * Throw an error if codegen fails on build.
    *
-   * @defaultValue `true`
+   * @default true
    */
   throwOnBuild?: boolean;
   /**
    * Run codegen when a document matches.
    *
-   * @defaultValue `true`
+   * @default true
    */
   matchOnDocuments?: boolean;
   /**
    * Run codegen when a schema matches.
    *
-   * @defaultValue `false`
+   * @default false
    */
   matchOnSchemas?: boolean;
   /**
@@ -81,7 +81,7 @@ export interface Options {
   /**
    * Log various steps to aid in tracking down bugs.
    *
-   * @defaultValue `false`
+   * @default false
    */
   debug?: boolean;
 }