From e9782d9943a1c2067fab6227a0fe7a0446855502 Mon Sep 17 00:00:00 2001 From: SegaraRai Date: Mon, 19 Dec 2022 12:09:30 +0900 Subject: [PATCH 1/3] fix(types): add `server.headers` typing --- .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..4fc820f32586 --- /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 8dabfa43f451..c4c42ff4bf74 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.70.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.70.0 + * @description + * Set custom HTTP response headers to be sent in `astro dev` and `astro preview`. + */ + server?: ServerConfig | ((options: { command: 'dev' | 'preview' }) => ServerConfig); /** From d9b085f8c166745119d009fc58788b4f08251ab3 Mon Sep 17 00:00:00 2001 From: SegaraRai Date: Tue, 20 Dec 2022 22:11:11 +0900 Subject: [PATCH 2/3] fix: correct `@version` of `server.headers` --- packages/astro/src/@types/astro.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index c4c42ff4bf74..8825ba9a0aa0 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -325,7 +325,7 @@ type ServerConfig = { * @name server.headers * @typeraw {OutgoingHttpHeaders} * @default `{}` - * @version 1.70.0 + * @version 1.7.0 * @description * Set custom HTTP response headers to be sent in `astro dev` and `astro preview`. */ @@ -682,7 +682,7 @@ export interface AstroUserConfig { * @name server.headers * @typeraw {OutgoingHttpHeaders} * @default `{}` - * @version 1.70.0 + * @version 1.7.0 * @description * Set custom HTTP response headers to be sent in `astro dev` and `astro preview`. */ From 7e906457f210739b307d57230ba6145146305475 Mon Sep 17 00:00:00 2001 From: Bjorn Lu Date: Wed, 21 Dec 2022 22:53:03 +0800 Subject: [PATCH 3/3] Update changeset --- .changeset/slow-nails-retire.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/slow-nails-retire.md b/.changeset/slow-nails-retire.md index 4fc820f32586..e8eaccbb47e0 100644 --- a/.changeset/slow-nails-retire.md +++ b/.changeset/slow-nails-retire.md @@ -2,4 +2,4 @@ 'astro': patch --- -- Add `server.headers` typing +Add `server.headers` typing