diff options
| author |  Chris Swithinbank <swithinbank@gmail.com>
| 2022-12-19 04:13:16 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-12-19 11:13:16 +0800 |
| commit | 7f7450e673301c977304df642511e3b9684cbad0 (patch) | |
| tree | 93070f7361cd20d398cd5ac30bbbdb5f59ebb81c | |
| parent | 8e67d75793e9986d1f39be98637eefdcea9da8ff (diff) | |
| download | astro-7f7450e673301c977304df642511e3b9684cbad0.tar.gz astro-7f7450e673301c977304df642511e3b9684cbad0.tar.zst astro-7f7450e673301c977304df642511e3b9684cbad0.zip | |
Add JSDoc comments for error overlay to match other experimental features (#5633)
| -rw-r--r-- | packages/astro/src/@types/astro.ts | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 8dabfa43f..9d1390ae1 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -907,8 +907,23 @@ export interface AstroUserConfig { */ experimental?: { /** - * @hidden + * @docs + * @name experimental.errorOverlay + * @type {boolean} + * @default `false` + * @version 1.7.0 + * @description * Turn on experimental support for the new error overlay component. + * + * To enable this feature, set `experimental.errorOverlay` to `true` in your Astro config: + * + * ```js + * { + * experimental: { + * errorOverlay: true, + * }, + * } + * ``` */ errorOverlay?: boolean; /** |