Skip to content

Commit

Permalink
Update types to specify that compress defaults to true (#8072)
Browse files Browse the repository at this point in the history
* Update types to specify that compress defaults to true

* Update astro.ts

---------

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
  • Loading branch information
matthewp and sarah11918 authored Aug 14, 2023
1 parent 5208a3c commit 4477bb4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .changeset/tasty-camels-speak.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Update Astro types to reflect that compress defaults to true
8 changes: 4 additions & 4 deletions packages/astro/src/@types/astro.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
* }
* ```
*/
Expand Down

0 comments on commit 4477bb4

Please sign in to comment.