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.

Sign up for GitHub

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

Jump to bottom

docs(plugins): note side-effect when using await in fastify.register() #4846

Merged
merged 2 commits into from
Jul 9, 2023
Merged

docs(plugins): note side-effect when using await in fastify.register() #4846

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63130ee
Add documentation for side-effect when using await in fastify.register()
andersonjoseph Jun 22, 2023
b1df7f9
Apply suggestions from code review
Uzlopak Jul 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/Reference/Plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@ await fastify.ready()

await fastify.listen({ port: 3000 })
```
*Note: Using await when registering a plugin finalizes the encapsulation
process, so any mutations to the instance after the plugin has been awaited will
not be reflected in the parent instance.
See: [Issue #3863](https://github.com/fastify/fastify/issues/3863#issuecomment-1114132490)*
Uzlopak marked this conversation as resolved.
Show resolved Hide resolved
Uzlopak marked this conversation as resolved.
Show resolved Hide resolved

#### ESM support
<a id="esm-support"></a>
Expand Down