getCacheEvents

Create the cache event emitters and listeners for data changes, invalidation, and deletion.

---

Import

import { getCacheEvents } from "@hyper-fetch/core"

Source

View the source code

Package

@hyper-fetch/core

Parameters

getCacheEvents(emitter: EventEmitter)

Parameters

Name	Type	Description
emitter	EventEmitter

Returns

getCacheEvents

Name	Type	Description
emitCacheData	<Response, Error, Adapter>(data: ResponseType<Response, Error, Adapter> & ResponseDetailsType & { cacheKey: string; cacheTime: number; cached: boolean; hydrated?: boolean; scope: (null | string); staleTime: number; version: string } & { cached: boolean }, isTriggeredExternally: boolean) => void	Set cache data
emitDelete	(cacheKey: string, isTriggeredExternally: boolean) => void	Delete of cache values
emitInvalidation	(cacheKey: string, isTriggeredExternally: boolean) => void	Invalidate cache values event
onData	<Response, Error, Adapter>(callback: (data: ResponseType<Response, Error, Adapter> & ResponseDetailsType & { cacheKey: string; cacheTime: number; cached: boolean; hydrated?: boolean; scope: (null | string); staleTime: number; version: string } & { cached: boolean }) => void) => VoidFunction	Cache data listener for all keys
onDataByKey	<Response, Error, Adapter>(cacheKey: string, callback: (data: CacheValueType<Response, Error, Adapter>) => void) => VoidFunction	Cache data listener filtered by a specific cache key
onDelete	(callback: (cacheKey: string) => void) => VoidFunction	Cache deletion listener for all keys
onDeleteByKey	(cacheKey: string, callback: () => void) => VoidFunction	Cache deletion listener filtered by a specific cache key
onInvalidate	(callback: (cacheKey: string) => void) => VoidFunction	Cache invalidation listener
onInvalidateByKey	(cacheKey: string, callback: () => void) => VoidFunction	Cache invalidation listener