Skip to content

chore: update documentation to include install commands for typescript #7691

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

Conversation

torressam333
Copy link
Contributor

@torressam333 torressam333 commented Aug 18, 2023

Proposed Changes

  • Update the documentation to include npm install commands for needed Typescript declaration files to prevent errors.

In the process of migrating from apollo-server-express to just using apollo-server v4 I was following the migration guide here: https://www.apollographql.com/docs/apollo-server/migration/#migrate-from-apollo-server-express and when I installed the cors package and imported it into my index.ts file I got the error shown in the readme.md file below. I believe it is important to include the corresponding Typescript commands to use for other users who will migrate to v4.

Thanks!

@apollo-cla
Copy link

@torressam333: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/

@netlify
Copy link

netlify bot commented Aug 18, 2023

👷 Deploy request for apollo-server-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit d5bfc4f

@codesandbox-ci
Copy link

codesandbox-ci bot commented Aug 18, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit d5bfc4f:

Sandbox Source
Apollo Server Typescript Configuration
Apollo Server Configuration

Copy link
Contributor

@trevor-scheer trevor-scheer left a comment

Choose a reason for hiding this comment

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

Good addition, thanks! Left a couple suggestions.

@torressam333 torressam333 force-pushed the torressamm333/typescript-install-packages branch from ecea6a4 to d5bfc4f Compare August 18, 2023 21:54
@torressam333
Copy link
Contributor Author

@trevor-scheer great suggestions! Changes have been made, commit has been squashed and is now updated.

Copy link
Contributor

@trevor-scheer trevor-scheer left a comment

Choose a reason for hiding this comment

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

Thanks!

@trevor-scheer trevor-scheer merged commit b72485a into apollographql:main Aug 18, 2023
@torressam333 torressam333 deleted the torressamm333/typescript-install-packages branch August 18, 2023 22:30
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 18, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants