Edits to docs for async start #5044
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
glasser
requested changes
Mar 22, 2021
docs/source/api/apollo-server.md
Outdated
| #### `applyMiddleware` | ||
|
|
||
| Connects Apollo Server to the HTTP framework of a Node.js middleware library, such as hapi or express. | ||
|
|
||
| You call this method instead of [`listen`](#listen) if you're using an `apollo-server-{integration}` package. You are highly recommended to [`await server.start()`](#start) before calling this method. | ||
| You call this method instead of [`listen`](#listen) if you're using an `apollo-server-{integration}` package. Unless you're using a "serverless" integration, always call [`await server.start()`](#start) _before_ calling this method. |
There was a problem hiding this comment.
The serverless integrations don't have applyMiddleware; they have createHandler. (Confusingly there is at least one non-serverless integration that has createHandler too.) This whole section is kinda weird because it attempts to document integration-specific methods in a generic way. We probably should at some point rethink how we document (or fail to document) the integration libraries.
glasser
pushed a commit
that referenced
this pull request
Mar 22, 2021
Co-authored-by: Stephen Barlow <stephenbarlow@APOLLO-StephenBarlow.attlocal.net> Co-authored-by: Stephen Barlow <stephenbarlow@apollo-stephenbarlow.gateway.sonic.net>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.