Skip to content

Commit 39a5642

Browse files
committed
Change @group from various groups to "Hooks" for hook functions
1 parent 2baf5ea commit 39a5642

5 files changed

Lines changed: 5 additions & 5 deletions

File tree

src/hooks/useDeepCompareEffect.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ import { deepCompare } from "../utils/compare"
4040
* @param callback The effect callback function
4141
* @param dependencies Array of dependencies to deep compare
4242
*
43-
* @group Utilities
43+
* @group Hooks
4444
*/
4545
export function useDeepCompareEffect(callback: EffectCallback, dependencies: DependencyList) {
4646
return useEffect(callback, useDeepCompareMemoize(dependencies))

src/hooks/useLoadClientScript.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ const defaultAttributes = { "nosto-client-script": "" }
5858
* }
5959
* ```
6060
*
61-
* @group Essential Functions
61+
* @group Hooks
6262
*/
6363
export function useLoadClientScript(props: NostoScriptProps) {
6464
const {

src/hooks/useNostoApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ import { API } from "@nosto/nosto-js/client"
4747
* @param deps Optional dependency list for useEffect
4848
* @param flags Optional flags, including `deep` for deep comparison of dependencies
4949
*
50-
* @group Essential Functions
50+
* @group Hooks
5151
*/
5252
export function useNostoApi(cb: (api: API) => void, deps?: DependencyList, flags?: { deep?: boolean }): void {
5353
const { clientScriptLoaded } = useNostoContext()

src/hooks/useNostoContext.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ import { NostoContext, NostoContextType } from "../context"
4242
* }
4343
* ```
4444
*
45-
* @group Essential Functions
45+
* @group Hooks
4646
*/
4747
export function useNostoContext(): NostoContextType {
4848
return useContext(NostoContext)

src/hooks/useRenderCampaigns.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ function injectCampaigns(data: CampaignData) {
8888
* }
8989
* ```
9090
*
91-
* @group Essential Functions
91+
* @group Hooks
9292
*/
9393
export function useRenderCampaigns() {
9494
const { responseMode, recommendationComponent } = useNostoContext()

0 commit comments

Comments
 (0)