InternalEndpointDataClient
Defined in: wp-typia-rest/src/react-client-types.ts:70
Shared cache client used by the React query and mutation helpers.
Remarks
Section titled “Remarks”The client owns normalized cache keys, invalidation, and optimistic cache writes without exposing transport implementation details to components.
Extends
Section titled “Extends”Methods
Section titled “Methods”invalidate()
Section titled “invalidate()”invalidate<
Req,Res>(endpoint,request?):void
Defined in: wp-typia-rest/src/react-client-types.ts:54
Type Parameters
Section titled “Type Parameters”Req
Res
Parameters
Section titled “Parameters”endpoint
Section titled “endpoint”ApiEndpoint<Req, Res>
request?
Section titled “request?”Req
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”refetch()
Section titled “refetch()”refetch<
Req,Res>(endpoint,request?):Promise<void>
Defined in: wp-typia-rest/src/react-client-types.ts:55
Type Parameters
Section titled “Type Parameters”Req
Res
Parameters
Section titled “Parameters”endpoint
Section titled “endpoint”ApiEndpoint<Req, Res>
request?
Section titled “request?”Req
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”getData()
Section titled “getData()”getData<
Req,Res>(endpoint,request):Res|undefined
Defined in: wp-typia-rest/src/react-client-types.ts:59
Type Parameters
Section titled “Type Parameters”Req
Res
Parameters
Section titled “Parameters”endpoint
Section titled “endpoint”ApiEndpoint<Req, Res>
request
Section titled “request”Req
Returns
Section titled “Returns”Res | undefined
Inherited from
Section titled “Inherited from”setData()
Section titled “setData()”setData<
Req,Res>(endpoint,request,next):void
Defined in: wp-typia-rest/src/react-client-types.ts:63
Type Parameters
Section titled “Type Parameters”Req
Res
Parameters
Section titled “Parameters”endpoint
Section titled “endpoint”ApiEndpoint<Req, Res>
request
Section titled “request”Req
EndpointDataUpdater<Res>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”__getSnapshot()
Section titled “__getSnapshot()”__getSnapshot(
cacheKey):EndpointDataSnapshot
Defined in: wp-typia-rest/src/react-client-types.ts:71
Parameters
Section titled “Parameters”cacheKey
Section titled “cacheKey”string
Returns
Section titled “Returns”EndpointDataSnapshot
__publishValidation()
Section titled “__publishValidation()”__publishValidation<
Req,Res>(cacheKey,validation):void
Defined in: wp-typia-rest/src/react-client-types.ts:72
Type Parameters
Section titled “Type Parameters”Req
Res
Parameters
Section titled “Parameters”cacheKey
Section titled “cacheKey”string
validation
Section titled “validation”EndpointValidationResult<Req, Res>
Returns
Section titled “Returns”void
__registerRefetcher()
Section titled “__registerRefetcher()”__registerRefetcher(
cacheKey,refetcher): () =>void
Defined in: wp-typia-rest/src/react-client-types.ts:76
Parameters
Section titled “Parameters”cacheKey
Section titled “cacheKey”string
refetcher
Section titled “refetcher”QueryRefetcher
Returns
Section titled “Returns”() => void
__runQuery()
Section titled “__runQuery()”__runQuery<
Req,Res>(cacheKey,execute,options):Promise<EndpointValidationResult<Req,Res>>
Defined in: wp-typia-rest/src/react-client-types.ts:80
Type Parameters
Section titled “Type Parameters”Req
Res
Parameters
Section titled “Parameters”cacheKey
Section titled “cacheKey”string
execute
Section titled “execute”() => Promise<EndpointValidationResult<Req, Res>>
options
Section titled “options”force?
Section titled “force?”boolean
staleTime
Section titled “staleTime”number
Returns
Section titled “Returns”Promise<EndpointValidationResult<Req, Res>>
__seedData()
Section titled “__seedData()”__seedData<
Res>(cacheKey,data):void
Defined in: wp-typia-rest/src/react-client-types.ts:85
Type Parameters
Section titled “Type Parameters”Res
Parameters
Section titled “Parameters”cacheKey
Section titled “cacheKey”string
Res
Returns
Section titled “Returns”void
__subscribe()
Section titled “__subscribe()”__subscribe(
cacheKey,listener): () =>void
Defined in: wp-typia-rest/src/react-client-types.ts:86
Parameters
Section titled “Parameters”cacheKey
Section titled “cacheKey”string
listener
Section titled “listener”EndpointDataListener
Returns
Section titled “Returns”() => void