docs: Add mention to ENVIRONMENT_INITIALIZER (#57464)

JeanMeche · AndrewKushnir · commit 3b7162d03c12 · 2024-08-29T07:43:48.000-07:00
Explicitly mention that `ENVIRONMENT_INITIALIZER` should not be async. PR Close #57464
diff --git a/packages/core/src/di/initializer_token.ts b/packages/core/src/di/initializer_token.ts
@@ -12,6 +12,9 @@ import {InjectionToken} from './injection_token';
  * A multi-provider token for initialization functions that will run upon construction of an
  * environment injector.
  *
+ * Note: As opposed to the `APP_INITIALIZER` token, the `ENVIRONMENT_INITIALIZER` functions are not awaited,
+ * hence they should not be `async`.
+ *
  * @publicApi
  */
 export const ENVIRONMENT_INITIALIZER = new InjectionToken<ReadonlyArray<() => void>>(
