Skip to content

Commit 5392ffe

Browse files
committed
docs: escape characters in hmr options doc that failed the api-extractor
1 parent e720cb3 commit 5392ffe

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

packages/vite-plugin-svelte/src/utils/options.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -208,22 +208,22 @@ export interface Options {
208208
* escape hatchs from preservation of local state
209209
* disable preservation of state for this component
210210
*
211-
* @default ['@hmr:reset', '@!hmr']
211+
* @default ['\@hmr:reset', '\@!hmr']
212212
*/
213213
noPreserveStateKey?: string[]
214214

215215
/**
216216
* enable preservation of state for all variables in this component
217217
*
218-
* @default '@hmr:keep-all'
218+
* @default '\@hmr:keep-all'
219219
*/
220220
preserveAllLocalStateKey?: string
221221

222222
/**
223223
* enable preservation of state for a given variable (must be inline or
224224
* above the target variable or variables; can be repeated)
225225
*
226-
* @default '@hmr:keep'
226+
* @default '\@hmr:keep'
227227
*/
228228
preserveLocalStateKey?: string
229229

@@ -250,7 +250,7 @@ export interface Options {
250250

251251
/**
252252
* auto accept modules of components have accessors (either accessors compile
253-
* option, or <svelte:option accessors={true} />) -- this means that if you
253+
* option, or \<svelte:option accessors=\{true\} /\>) -- this means that if you
254254
* set accessors compile option globally, you must also set this option to
255255
* true, or no component will be hot reloaded (but there are a lot of edge
256256
* cases that HMR can't support correctly with accessors)

0 commit comments

Comments
 (0)