Skip to content

Commit 5b85be2

Browse files
committed
fix: update jsdoc for default value
1 parent 6a175a9 commit 5b85be2

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,43 +43,43 @@ codegen({
4343
/**
4444
* Run codegen on server start.
4545
*
46-
* @defaultValue `true`
46+
* @default true
4747
*/
4848
runOnStart: boolean,
4949
/**
5050
* Run codegen on build. Will prevent build if codegen fails.
5151
*
52-
* @defaultValue `true`
52+
* @default true
5353
*/
5454
runOnBuild: boolean,
5555
/**
5656
* Enable codegen integration with vite file watcher.
5757
*
58-
* @defaultValue `true`
58+
* @default true
5959
*/
6060
enableWatcher: boolean,
6161
/**
6262
* Throw an error if codegen fails on server start.
6363
*
64-
* @defaultValue `false`
64+
* @default false
6565
*/
6666
throwOnStart: boolean,
6767
/**
6868
* Throw an error if codegen fails on build.
6969
*
70-
* @defaultValue `true`
70+
* @default true
7171
*/
7272
throwOnBuild: boolean,
7373
/**
7474
* Run codegen when a document matches.
7575
*
76-
* @defaultValue `true`
76+
* @default true
7777
*/
7878
matchOnDocuments: boolean,
7979
/**
8080
* Run codegen when a schema matches.
8181
*
82-
* @defaultValue `false`
82+
* @default false
8383
*/
8484
matchOnSchemas: boolean,
8585
/**
@@ -109,7 +109,7 @@ codegen({
109109
/**
110110
* Log various steps to aid in tracking down bugs.
111111
*
112-
* @defaultValue `false`
112+
* @default false
113113
*/
114114
debug: boolean,
115115
});

src/index.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,43 +15,43 @@ export interface Options {
1515
/**
1616
* Run codegen on server start.
1717
*
18-
* @defaultValue `true`
18+
* @default true
1919
*/
2020
runOnStart?: boolean;
2121
/**
2222
* Run codegen on build. Will prevent build if codegen fails.
2323
*
24-
* @defaultValue `true`
24+
* @default true
2525
*/
2626
runOnBuild?: boolean;
2727
/**
2828
* Enable codegen integration with vite file watcher.
2929
*
30-
* @defaultValue `true`
30+
* @default true
3131
*/
3232
enableWatcher?: boolean;
3333
/**
3434
* Throw an error if codegen fails on server start.
3535
*
36-
* @defaultValue `false`
36+
* @default false
3737
*/
3838
throwOnStart?: boolean;
3939
/**
4040
* Throw an error if codegen fails on build.
4141
*
42-
* @defaultValue `true`
42+
* @default true
4343
*/
4444
throwOnBuild?: boolean;
4545
/**
4646
* Run codegen when a document matches.
4747
*
48-
* @defaultValue `true`
48+
* @default true
4949
*/
5050
matchOnDocuments?: boolean;
5151
/**
5252
* Run codegen when a schema matches.
5353
*
54-
* @defaultValue `false`
54+
* @default false
5555
*/
5656
matchOnSchemas?: boolean;
5757
/**
@@ -81,7 +81,7 @@ export interface Options {
8181
/**
8282
* Log various steps to aid in tracking down bugs.
8383
*
84-
* @defaultValue `false`
84+
* @default false
8585
*/
8686
debug?: boolean;
8787
}

0 commit comments

Comments
 (0)