fix(core): improve docs on afterRender hooks (#56522)

cexbrayat · AndrewKushnir · commit 86bcfd3e498b · 2024-06-20T08:51:35.000-07:00
This commit fixes a typo in the `AfterRenderPhase` deprecation warning and improves the documentation of the options parameter of the afterRender hooks (which are now all named `options` instead of being called `opts` in some functions and `options` in others). PR Close #56522
diff --git a/goldens/public-api/core/index.api.md b/goldens/public-api/core/index.api.md
@@ -33,7 +33,7 @@ export function afterNextRender<E = never, W = never, M = never>(spec: {
     write?: (...args: ɵFirstAvailable<[E]>) => W;
     mixedReadWrite?: (...args: ɵFirstAvailable<[W, E]>) => M;
     read?: (...args: ɵFirstAvailable<[M, W, E]>) => void;
-}, opts?: Omit<AfterRenderOptions, 'phase'>): AfterRenderRef;
+}, options?: Omit<AfterRenderOptions, 'phase'>): AfterRenderRef;
 
 // @public
 export function afterNextRender(callback: VoidFunction, options?: AfterRenderOptions): AfterRenderRef;
@@ -44,7 +44,7 @@ export function afterRender<E = never, W = never, M = never>(spec: {
     write?: (...args: ɵFirstAvailable<[E]>) => W;
     mixedReadWrite?: (...args: ɵFirstAvailable<[W, E]>) => M;
     read?: (...args: ɵFirstAvailable<[M, W, E]>) => void;
-}, opts?: Omit<AfterRenderOptions, 'phase'>): AfterRenderRef;
+}, options?: Omit<AfterRenderOptions, 'phase'>): AfterRenderRef;
 
 // @public
 export function afterRender(callback: VoidFunction, options?: AfterRenderOptions): AfterRenderRef;
diff --git a/packages/core/src/render3/after_render_hooks.ts b/packages/core/src/render3/after_render_hooks.ts
@@ -49,7 +49,7 @@ export type ɵFirstAvailable<T extends unknown[]> = T extends [infer H, ...infer
  * or library.
  *
  * @deprecated Specify the phase for your callback to run in by passing a spec-object as the first
- *   parameter to `afterRender` or `afterNextRender` insetad of a function.
+ *   parameter to `afterRender` or `afterNextRender` instead of a function.
  */
 export enum AfterRenderPhase {
   /**
@@ -119,7 +119,7 @@ export interface AfterRenderOptions {
    * </div>
    *
    * @deprecated Specify the phase for your callback to run in by passing a spec-object as the first
-   *   parameter to `afterRender` or `afterNextRender` insetad of a function.
+   *   parameter to `afterRender` or `afterNextRender` instead of a function.
    */
   phase?: AfterRenderPhase;
 }
@@ -238,6 +238,7 @@ export function internalAfterNextRender(
  * </div>
  *
  * @param spec The callback functions to register
+ * @param options Options to control the behavior of the callback
  *
  * @usageNotes
  *
@@ -271,7 +272,7 @@ export function afterRender<E = never, W = never, M = never>(
     mixedReadWrite?: (...args: ɵFirstAvailable<[W, E]>) => M;
     read?: (...args: ɵFirstAvailable<[M, W, E]>) => void;
   },
-  opts?: Omit<AfterRenderOptions, 'phase'>,
+  options?: Omit<AfterRenderOptions, 'phase'>,
 ): AfterRenderRef;
 
 /**
@@ -299,6 +300,7 @@ export function afterRender<E = never, W = never, M = never>(
  * </div>
  *
  * @param callback A callback function to register
+ * @param options Options to control the behavior of the callback
  *
  * @usageNotes
  *
@@ -412,6 +414,7 @@ export function afterRender(
  * </div>
  *
  * @param spec The callback functions to register
+ * @param options Options to control the behavior of the callback
  *
  * @usageNotes
  *
@@ -447,7 +450,7 @@ export function afterNextRender<E = never, W = never, M = never>(
     mixedReadWrite?: (...args: ɵFirstAvailable<[W, E]>) => M;
     read?: (...args: ɵFirstAvailable<[M, W, E]>) => void;
   },
-  opts?: Omit<AfterRenderOptions, 'phase'>,
+  options?: Omit<AfterRenderOptions, 'phase'>,
 ): AfterRenderRef;
 
 /**
@@ -474,6 +477,7 @@ export function afterNextRender<E = never, W = never, M = never>(
  * </div>
  *
  * @param callback A callback function to register
+ * @param options Options to control the behavior of the callback
  *
  * @usageNotes
  *

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ export type ɵFirstAvailable<T extends unknown[]> = T extends [infer H, ...infer`
`49`	`49`	`* or library.`
`50`	`50`	`*`
`51`	`51`	`* @deprecated Specify the phase for your callback to run in by passing a spec-object as the first`
`52`		- * parameter to `afterRender` or `afterNextRender` insetad of a function.
	`52`	+ * parameter to `afterRender` or `afterNextRender` instead of a function.
`53`	`53`	`*/`
`54`	`54`	`export enum AfterRenderPhase {`
`55`	`55`	`/**`
`@@ -119,7 +119,7 @@ export interface AfterRenderOptions {`
`119`	`119`	`* </div>`
`120`	`120`	`*`
`121`	`121`	`* @deprecated Specify the phase for your callback to run in by passing a spec-object as the first`
`122`		- * parameter to `afterRender` or `afterNextRender` insetad of a function.
	`122`	+ * parameter to `afterRender` or `afterNextRender` instead of a function.
`123`	`123`	`*/`
`124`	`124`	`phase?: AfterRenderPhase;`
`125`	`125`	`}`
`@@ -238,6 +238,7 @@ export function internalAfterNextRender(`
`238`	`238`	`* </div>`
`239`	`239`	`*`
`240`	`240`	`* @param spec The callback functions to register`
	`241`	`+ * @param options Options to control the behavior of the callback`
`241`	`242`	`*`
`242`	`243`	`* @usageNotes`
`243`	`244`	`*`
`@@ -271,7 +272,7 @@ export function afterRender<E = never, W = never, M = never>(`
`271`	`272`	`mixedReadWrite?: (...args: ɵFirstAvailable<[W, E]>) => M;`
`272`	`273`	`read?: (...args: ɵFirstAvailable<[M, W, E]>) => void;`
`273`	`274`	`},`
`274`		`- opts?: Omit<AfterRenderOptions, 'phase'>,`
	`275`	`+ options?: Omit<AfterRenderOptions, 'phase'>,`
`275`	`276`	`): AfterRenderRef;`
`276`	`277`
`277`	`278`	`/**`
`@@ -299,6 +300,7 @@ export function afterRender<E = never, W = never, M = never>(`
`299`	`300`	`* </div>`
`300`	`301`	`*`
`301`	`302`	`* @param callback A callback function to register`
	`303`	`+ * @param options Options to control the behavior of the callback`
`302`	`304`	`*`
`303`	`305`	`* @usageNotes`
`304`	`306`	`*`
`@@ -412,6 +414,7 @@ export function afterRender(`
`412`	`414`	`* </div>`
`413`	`415`	`*`
`414`	`416`	`* @param spec The callback functions to register`
	`417`	`+ * @param options Options to control the behavior of the callback`
`415`	`418`	`*`
`416`	`419`	`* @usageNotes`
`417`	`420`	`*`
`@@ -447,7 +450,7 @@ export function afterNextRender<E = never, W = never, M = never>(`
`447`	`450`	`mixedReadWrite?: (...args: ɵFirstAvailable<[W, E]>) => M;`
`448`	`451`	`read?: (...args: ɵFirstAvailable<[M, W, E]>) => void;`
`449`	`452`	`},`
`450`		`- opts?: Omit<AfterRenderOptions, 'phase'>,`
	`453`	`+ options?: Omit<AfterRenderOptions, 'phase'>,`
`451`	`454`	`): AfterRenderRef;`
`452`	`455`
`453`	`456`	`/**`
`@@ -474,6 +477,7 @@ export function afterNextRender<E = never, W = never, M = never>(`
`474`	`477`	`* </div>`
`475`	`478`	`*`
`476`	`479`	`* @param callback A callback function to register`
	`480`	`+ * @param options Options to control the behavior of the callback`
`477`	`481`	`*`
`478`	`482`	`* @usageNotes`
`479`	`483`	`*`