Skip to content

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

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

Closed
cexbrayat wants to merge 1 commit into from
Closed

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

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions goldens/public-api/core/index.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand Down
12 changes: 8 additions & 4 deletions packages/core/src/render3/after_render_hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/**
Expand Down Expand Up @@ -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;
}
Expand Down Expand Up @@ -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
*
Expand Down Expand Up @@ -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;

/**
Expand Down Expand Up @@ -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
*
Expand Down Expand Up @@ -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
*
Expand Down Expand Up @@ -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;

/**
Expand All @@ -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
*
Expand Down