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

Update types to specify that compress defaults to true (#8072)

Browse source 
* Update types to specify that compress defaults to true

* Update astro.ts

---------

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
This commit is contained in:
Matthew Phillips 2023-08-14 11:10:37 -04:00 committed by GitHub
parent 5208a3c8fe
commit 4477bb41c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/tasty-camels-speak.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Update Astro types to reflect that compress defaults to true

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

@ -542,14 +542,14 @@ export interface AstroUserConfig {
* @docs
* @name compressHTML
* @type {boolean}
* @default `false`
* @default `true`
* @description
* This is an option to minify your HTML output and reduce the size of your HTML files. When enabled, Astro removes all whitespace from your HTML, including line breaks, from `.astro` components. This occurs both in development mode and in the final build.
* To enable this, set the `compressHTML` flag to `true`.
* This is an option to minify your HTML output and reduce the size of your HTML files. By default, Astro removes all whitespace from your HTML, including line breaks, from `.astro` components. This occurs both in development mode and in the final build.
* To disable HTML compression, set the `compressHTML` flag to `false`.
*
* ```js
* {
* compressHTML: true
* compressHTML: false
* }
* ```
*/