docs(component-store): clarify effect description (ngrx#2997)

LayZeeDK · web-flow · commit 53f3879ed19d · 2021-04-19T16:27:37.000-05:00
diff --git a/modules/component-store/src/component-store.ts b/modules/component-store/src/component-store.ts
@@ -266,7 +266,7 @@ export class ComponentStore<T extends object> implements OnDestroy {
   /**
    * Creates an effect.
    *
-   * This effect is subscribed to for the life of the @Component.
+   * This effect is subscribed to throughout the lifecycle of the ComponentStore.
    * @param generator A function that takes an origin Observable input and
    *     returns an Observable. The Observable that is returned will be
    *     subscribed to for the life of the component.

Original file line number	Diff line number	Diff line change
`@@ -266,7 +266,7 @@ export class ComponentStore<T extends object> implements OnDestroy {`
`266`	`266`	`/**`
`267`	`267`	`* Creates an effect.`
`268`	`268`	`*`
`269`		`- * This effect is subscribed to for the life of the @Component.`
	`269`	`+ * This effect is subscribed to throughout the lifecycle of the ComponentStore.`
`270`	`270`	`* @param generator A function that takes an origin Observable input and`
`271`	`271`	`* returns an Observable. The Observable that is returned will be`
`272`	`272`	`* subscribed to for the life of the component.`