Skip to content
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.

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

fix: document open option #7418

Merged
merged 3 commits into from
Jun 20, 2023
Merged

fix: document open option #7418

merged 3 commits into from
Jun 20, 2023

Conversation

ematipico
Copy link
Member

Changes

Closes #7398

For some reason server.open wasn't correctly typed. This fixes it.

Testing

Manual check

Docs

/cc @withastro/maintainers-docs for feedback!

@ematipico ematipico requested a review from a team as a code owner June 19, 2023 12:41
@changeset-bot
Copy link

changeset-bot bot commented Jun 19, 2023

🦋 Changeset detected

Latest commit: 86fbaa8

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added the pkg: astro Related to the core `astro` package (scope) label Jun 19, 2023
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
Copy link
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also copy the docs to here?

/**
* @docs
* @name server.headers
* @typeraw {OutgoingHttpHeaders}
* @default `{}`
* @version 1.7.0
* @description
* Set custom HTTP response headers to be sent in `astro dev` and `astro preview`.
*/
server?: ServerConfig | ((options: { command: 'dev' | 'preview' }) => ServerConfig);

A bit strange to do so, but maybe good so docs pick up the jsdoc.

@ematipico
Copy link
Member Author

Should we also copy the docs to here?

/**
* @docs
* @name server.headers
* @typeraw {OutgoingHttpHeaders}
* @default `{}`
* @version 1.7.0
* @description
* Set custom HTTP response headers to be sent in `astro dev` and `astro preview`.
*/
server?: ServerConfig | ((options: { command: 'dev' | 'preview' }) => ServerConfig);

A bit strange to do so, but maybe good so docs pick up the jsdoc.

Oh, I didn't see that section. Yes, it makes sense to copy them over

@ematipico ematipico requested a review from bluwy June 20, 2023 10:42
@ematipico ematipico merged commit 2b34fc4 into main Jun 20, 2023
15 checks passed
@ematipico ematipico deleted the fix/document-open-option branch June 20, 2023 14:24
@astrobot-houston astrobot-houston mentioned this pull request Jun 20, 2023
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: astro Related to the core `astro` package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Some configuration keys in server.* are not typed and some inside vite.server.* are ignored
3 participants