From 376f67011d220de3bf05d3f39779a708992fffd7 Mon Sep 17 00:00:00 2001 From: SegaraRai Date: Wed, 28 Dec 2022 01:07:49 +0900 Subject: [PATCH] fix(types): add `server.headers` typing (#5635) * fix(types): add `server.headers` typing * fix: correct `@version` of `server.headers` * Update changeset Co-authored-by: Bjorn Lu --- .changeset/slow-nails-retire.md | 5 +++++ packages/astro/src/@types/astro.ts | 21 +++++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 .changeset/slow-nails-retire.md diff --git a/.changeset/slow-nails-retire.md b/.changeset/slow-nails-retire.md new file mode 100644 index 000000000000..e8eaccbb47e0 --- /dev/null +++ b/.changeset/slow-nails-retire.md @@ -0,0 +1,5 @@ +--- +'astro': patch +--- + +Add `server.headers` typing diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 9d1390ae1e4c..c5839058a800 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -8,6 +8,7 @@ import type { ShikiConfig, } from '@astrojs/markdown-remark'; import type * as babel from '@babel/core'; +import type { OutgoingHttpHeaders } from 'http'; import type { AddressInfo } from 'net'; import type { TsConfigJson } from 'tsconfig-resolver'; import type * as vite from 'vite'; @@ -319,6 +320,16 @@ type ServerConfig = { * If the given port is already in use, Astro will automatically try the next available port. */ port?: number; + + /** + * @name server.headers + * @typeraw {OutgoingHttpHeaders} + * @default `{}` + * @version 1.7.0 + * @description + * Set custom HTTP response headers to be sent in `astro dev` and `astro preview`. + */ + headers?: OutgoingHttpHeaders; }; export interface ViteUserConfig extends vite.UserConfig { @@ -666,6 +677,16 @@ export interface AstroUserConfig { * ``` */ + /** + * @docs + * @name server.headers + * @typeraw {OutgoingHttpHeaders} + * @default `{}` + * @version 1.7.0 + * @description + * Set custom HTTP response headers to be sent in `astro dev` and `astro preview`. + */ + server?: ServerConfig | ((options: { command: 'dev' | 'preview' }) => ServerConfig); /**