michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add JSDoc comments for error overlay to match other experimental features (#5633)

Browse source
This commit is contained in:
Chris Swithinbank 2022-12-19 04:13:16 +01:00 committed by GitHub
parent 8e67d75793
commit 7f7450e673
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
packages/astro/src/@types/astro.ts
View file

@ -907,8 +907,23 @@ export interface AstroUserConfig {
*/ */
experimental?: { 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. * 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; errorOverlay?: boolean;
/** /**