@@ -80,59 +80,68 @@ export type Redirect = {
80
80
export interface LibConfig extends RsbuildConfig {
81
81
/**
82
82
* The unique identifier of the library.
83
- * @default undefined
83
+ * @defaultValue `undefined`
84
+ * @see {@link https://lib.rsbuild.dev/config/lib/id }
84
85
*/
85
86
id ?: string ;
86
87
/**
87
88
* Output format for the generated JavaScript files.
88
- * @default undefined
89
+ * @defaultValue `undefined`
90
+ * @see {@link https://lib.rsbuild.dev/config/lib/format }
89
91
*/
90
92
format ?: Format ;
91
93
/**
92
94
* Whether to bundle the library.
93
- * @default true
95
+ * @defaultValue `true`
96
+ * @see {@link https://lib.rsbuild.dev/config/lib/bundle }
94
97
*/
95
98
bundle ?: boolean ;
96
99
/**
97
- * Whether to automatically set the file extension based on the `format` option in the JavaScript output files.
98
- * @default true
100
+ * Whether to automatically set the file extension based on {@link format} option in the JavaScript output files.
101
+ * @defaultValue `true`
102
+ * @see {@link https://lib.rsbuild.dev/config/lib/auto-extension }
99
103
*/
100
104
autoExtension ?: boolean ;
101
105
/**
102
106
* Whether to automatically externalize dependencies of different dependency types and do not bundle them.
103
- * @default true
107
+ * @defaultValue `true`
108
+ * @see {@link https://lib.rsbuild.dev/config/lib/auto-external }
104
109
*/
105
110
autoExternal ?: AutoExternal ;
106
111
/**
107
- * Configure the redirect of the import paths, applicable when `bundle: false`.
108
- * @default {}
112
+ * Configure the redirect of the import paths, applicable {@link bundle} is set to `false`.
113
+ * @defaultValue `{}`
114
+ * @see {@link https://lib.rsbuild.dev/config/lib/redirect}
109
115
*/
110
116
redirect ?: Redirect ;
111
117
/**
112
118
* Configure the syntax to which JavaScript and CSS will be downgraded.
113
- * Support ECMAScript version and browserslist query.
114
- * @default 'esnext'
119
+ * @defaultValue `'esnext'`
120
+ * @see { @link https://lib.rsbuild.dev/config/lib/syntax }
115
121
*/
116
122
syntax ?: Syntax ;
117
123
/**
118
124
* Whether to import SWC helper functions from `@swc/helpers` instead of inlining them.
119
- * @default false
125
+ * @defaultValue `false`
126
+ * @see {@link https://lib.rsbuild.dev/config/lib/external-helpers }
120
127
*/
121
128
externalHelpers ?: boolean ;
122
129
/**
123
130
* Inject content into the top of each JS, CSS or DTS file.
124
- * @default {}
131
+ * @defaultValue `{}`
132
+ * @see {@link https://lib.rsbuild.dev/config/lib/banner}
125
133
*/
126
134
banner ?: BannerAndFooter ;
127
135
/**
128
136
* Inject content into the bottom of each JS, CSS or DTS file.
129
- * @default {}
137
+ * @defaultValue `{}`
138
+ * @see {@link https://lib.rsbuild.dev/config/lib/footer}
130
139
*/
131
140
footer ?: BannerAndFooter ;
132
141
/**
133
142
* Configure the shims for CommonJS and ESM output.
134
143
*
135
- * @default
144
+ * @defaultValue
136
145
* ```js
137
146
* const defaultShims = {
138
147
* cjs: {
@@ -145,16 +154,19 @@ export interface LibConfig extends RsbuildConfig {
145
154
* },
146
155
* };
147
156
* ```
157
+ * @see {@link https://lib.rsbuild.dev/config/lib/shims }
148
158
*/
149
159
shims ?: Shims ;
150
160
/**
151
161
* Configure the generation of the TypeScript declaration files.
152
- * @default false
162
+ * @defaultValue `false`
163
+ * @see {@link https://lib.rsbuild.dev/config/lib/dts }
153
164
*/
154
165
dts ?: Dts ;
155
166
/**
156
167
* The export name of the UMD bundle.
157
- * @default undefined
168
+ * @defaultValue `undefined`
169
+ * @see {@link https://lib.rsbuild.dev/config/lib/umd-name }
158
170
*/
159
171
umdName ?: string ;
160
172
}
0 commit comments