Skip to content

docs: clarify lifecycle events #3281

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify lifecycle events #3281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/fundamentals/lifecycle-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In the following table, `onModuleDestroy`, `beforeApplicationShutdown` and `onAp

| Lifecycle hook method | Lifecycle event triggering the hook method call |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `onModuleInit()` | Called once the host module's dependencies have been resolved. |
| `onModuleInit()` | Called once the host module's dependencies have been resolved. "Once" meaning called AFTER the host module's dependencies have been resolved, but not necessarily one time only. |
Copy link
Member

Choose a reason for hiding this comment

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

Not sure if I'm following. This hook is called one time only per each provider that implements it. The change you suggested ("not necessarily one time only") may lead someone to think that it might be called several times for the same provider (which isn't true). Correct me if I'm wrong

| `onApplicationBootstrap()` | Called once all modules have been initialized, but before listening for connections. |
| `onModuleDestroy()`\* | Called after a termination signal (e.g., `SIGTERM`) has been received. |
| `beforeApplicationShutdown()`\* | Called after all `onModuleDestroy()` handlers have completed (Promises resolved or rejected);<br />once complete (Promises resolved or rejected), all existing connections will be closed (`app.close()` called). |
Expand Down