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

[docs] remove experimental from image configs (#8282)

Browse source
This commit is contained in:
Sarah Rainsberger 2023-08-30 10:12:45 -03:00 committed by GitHub
parent 5598feb718
commit a0955f769f
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/hot-timers-wink.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Remove "experimental" text from the image config options, for docs and editor etc. text displayed.

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

@ -975,7 +975,7 @@ export interface AstroUserConfig {
image?: {
/**
* @docs
* @name image.service (Experimental)
* @name image.service
* @type {{entrypoint: 'astro/assets/services/sharp' | 'astro/assets/services/squoosh' | string, config: Record<string, any>}}
* @default `{entrypoint: 'astro/assets/services/sharp', config?: {}}`
* @version 2.1.0
@ -999,14 +999,14 @@ export interface AstroUserConfig {
/**
* @docs
* @name image.domains (Experimental)
* @name image.domains
* @type {string[]}
* @default `{domains: []}`
* @version 2.10.10
* @description
* Defines a list of permitted image source domains for local image optimization. No other remote images will be optimized by Astro.
*
* This option requires an array of individual domain names as strings. Wildcards are not permitted. Instead, use [`image.remotePatterns`](#imageremotepatterns-experimental) to define a list of allowed source URL patterns.
* This option requires an array of individual domain names as strings. Wildcards are not permitted. Instead, use [`image.remotePatterns`](#imageremotepatterns) to define a list of allowed source URL patterns.
*
* ```js
* // astro.config.mjs
@ -1022,7 +1022,7 @@ export interface AstroUserConfig {
/**
* @docs
* @name image.remotePatterns (Experimental)
* @name image.remotePatterns
* @type {RemotePattern[]}
* @default `{remotePatterns: []}`
* @version 2.10.10