Skip to content

fix(types): add server.allowedHosts docs comment to AstroUserConfig #13660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 22, 2025
Merged

fix(types): add server.allowedHosts docs comment to AstroUserConfig #13660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
215072e
fix(types): add `server.allowedHosts` docs comment to `AstroUserConfig`
mingjunlu Apr 20, 2025
0af7f6d
chore: add changeset
mingjunlu Apr 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/dull-teeth-cut.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Adds `server.allowedHosts` docs comment to `AstroUserConfig`
20 changes: 20 additions & 0 deletions packages/astro/src/types/public/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,26 @@ export interface ViteUserConfig extends OriginalViteUserConfig {
* ```
*/

/**
* @docs
* @name server.allowedHosts
* @type {string[] | true}
* @default `[]`
* @version 5.4.0
* @description
*
* A list of hostnames that Astro is allowed to respond to. When the value is set to `true`, any
* hostname is allowed.
*
* ```js
* {
* server: {
* allowedHosts: ['staging.example.com', 'qa.example.com']
* }
* }
* ```
*/

/**
* @docs
* @name server.open
Expand Down