summaryrefslogtreecommitdiff
path: root/packages
diff options
context:
space:
mode:
authorGravatar Emanuele Stoppa <my.burning@gmail.com> 2023-06-20 15:24:29 +0100
committerGravatar GitHub <noreply@github.com> 2023-06-20 15:24:29 +0100
commit2b34fc49282cbf5bf89de46359b51a67a5c4b8bb (patch)
tree1a0d3b58a6b41bba87938f82b4672e2339a4ab2d /packages
parent89a4835202f05d9571aeb42740dbe907a8afc28b (diff)
downloadastro-2b34fc49282cbf5bf89de46359b51a67a5c4b8bb.tar.gz
astro-2b34fc49282cbf5bf89de46359b51a67a5c4b8bb.tar.zst
astro-2b34fc49282cbf5bf89de46359b51a67a5c4b8bb.zip
fix: document `open` option (#7418)
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
Diffstat (limited to 'packages')
-rw-r--r--packages/astro/src/@types/astro.ts31
1 files changed, 31 insertions, 0 deletions
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts
index 59594446c..a3fcdcedd 100644
--- a/packages/astro/src/@types/astro.ts
+++ b/packages/astro/src/@types/astro.ts
@@ -335,6 +335,22 @@ type ServerConfig = {
* Set custom HTTP response headers to be sent in `astro dev` and `astro preview`.
*/
headers?: OutgoingHttpHeaders;
+
+ /**
+ * @name server.open
+ * @type {boolean}
+ * @default `false`
+ * @version 2.1.8
+ * @description
+ * Control whether the dev server should open in your browser window on startup.
+ *
+ * ```js
+ * {
+ * server: { open: true }
+ * }
+ * ```
+ */
+ open?: boolean;
};
export interface ViteUserConfig extends vite.UserConfig {
@@ -879,6 +895,21 @@ export interface AstroUserConfig {
*/
/**
+ * @name server.open
+ * @type {boolean}
+ * @default `false`
+ * @version 2.1.8
+ * @description
+ * Control whether the dev server should open in your browser window on startup.
+ *
+ * ```js
+ * {
+ * server: { open: true }
+ * }
+ * ```
+ */
+
+ /**
* @docs
* @name server.headers
* @typeraw {OutgoingHttpHeaders}