Skip to content

Commit

Permalink
comment updates
Browse files Browse the repository at this point in the history
  • Loading branch information
nreese committed Apr 9, 2024
1 parent 9a270b4 commit 3bb7463
Showing 1 changed file with 4 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ const hasSubjectsArrayChanged = (

/**
* Batches the latest values of multiple publishing subjects into a single object. Use this to avoid unnecessary re-renders.
* You should avoid using this hook with subjects that your component pushes values to on user interaction, as it can cause a slight delay.
* Use when `subjects` may not be defined on initial component render.
*
* @param subjects Publishing subjects array.
* When 'subjects' is expected to change, 'subjects' must be part of component react state.
*/
Expand Down Expand Up @@ -98,7 +99,8 @@ export const useBatchedOptionalPublishingSubjects = <

/**
* Batches the latest values of multiple publishing subjects into a single object. Use this to avoid unnecessary re-renders.
* You should avoid using this hook with subjects that your component pushes values to on user interaction, as it can cause a slight delay.
* Use when `subjects` are static and do not change over the lifetime of the component.
*
* @param subjects Publishing subjects array.
*/
export const useBatchedPublishingSubjects = <
Expand Down

0 comments on commit 3bb7463

Please sign in to comment.