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

docs: Update server options configuration reference (#3295)

Browse source 
Based on https://github.com/withastro/docs/pull/422/

Co-Authored-By: Rafid Muhymin Wafi <63650415+RafidMuhymin@users.noreply.github.com>

Co-authored-by: Rafid Muhymin Wafi <63650415+RafidMuhymin@users.noreply.github.com>
This commit is contained in:
Chris Swithinbank 2022-05-07 09:56:39 +02:00 committed by GitHub
parent 2864d09ad4
commit ee55d492b5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -432,11 +432,11 @@ export interface AstroUserConfig {
* @name Server Options * @name Server Options
* @description * @description
* *
* Customize the Astro dev server, used by both `astro dev` and `astro serve`. * Customize the Astro dev server, used by both `astro dev` and `astro preview`.
* *
* ```js * ```js
* { * {
* server: {port: 1234, host: true} * server: { port: 1234, host: true}
* } * }
* ``` * ```
* *
@ -445,7 +445,7 @@ export interface AstroUserConfig {
* ```js * ```js
* { * {
* // Example: Use the function syntax to customize based on command * // Example: Use the function syntax to customize based on command
* server: (command) => ({port: command === 'dev' ? 3000 : 4000}) * server: (command) => ({ port: command === 'dev' ? 3000 : 4000 })
* } * }
* ``` * ```
*/ */
@ -457,10 +457,10 @@ export interface AstroUserConfig {
* @default `false` * @default `false`
* @version 0.24.0 * @version 0.24.0
* @description * @description
* Set which network IP addresses the dev server should listen on (i.e. non-localhost IPs). * Set which network IP addresses the server should listen on (i.e. non-localhost IPs).
* - `false` - do not expose on a network IP address * - `false` - do not expose on a network IP address
* - `true` - listen on all addresses, including LAN and public addresses * - `true` - listen on all addresses, including LAN and public addresses
* - `[custom-address]` - expose on a network IP address at `[custom-address]` * - `[custom-address]` - expose on a network IP address at `[custom-address]` (ex: `192.168.0.1`)
*/ */
/** /**
@ -469,9 +469,15 @@ export interface AstroUserConfig {
* @type {number} * @type {number}
* @default `3000` * @default `3000`
* @description * @description
* Set which port the dev server should listen on. * Set which port the server should listen on.
* *
* If the given port is already in use, Astro will automatically try the next available port. * If the given port is already in use, Astro will automatically try the next available port.
*
* ```js
* {
* server: { port: 8080 }
* }
* ```
*/ */
server?: ServerConfig | ((options: { command: 'dev' | 'preview' }) => ServerConfig); server?: ServerConfig | ((options: { command: 'dev' | 'preview' }) => ServerConfig);