Cache System

A Map based cache, disabled by default and triggered by the cacheInMemory flag.

As you know, you can access Map items using a key, in this Cache System the key is identified with the name cacheKey. It can be:

• Provided during the RestClient/createRestClient initialization
• Updated via RestClient.options property (RestClientBuilder methods) or setOption function (in Functional API)
• Overridden on any local request method (or any equivalent http shortcut)

See Advanced usage to get an example.

This internal cache system will never infer the native Request.cache property's behavior.

Enabling it, if a cached response for a particular request exists, the library will avoid the fetch call to resolve the Promise immediately.

TIP

Once enabled, it can works together with the Standard Fetch API's cache mechanism (link). Keep in mind that Standard Cache mechanism will run only if the in memory cache haven't any cached record at the check time, in other words, the built-in cache system has the priority because is executed first.

The following list of functions will be available:

• On RestClient's instance as public methods
• On the destructible object returned by the chain createRestClient() => useRestClient()

cacheKey

(url: URL, method: HttpMethod | "*" = "*", customKey?: string) => string

Evaluate the unique cache-key for a particular request, having the provided url, (optional) method, combining this couple with the cacheKey option.

Providing the third parameter customKey, the string evaluated will change accordingly.

This method is used internally to complete common cache's task operations like set, get and clear; see the next methods to understand better.

cacheSet

(response: IResponse, customKey?: string) => void

Store the response object provided to the internal RestClient instance's cache.

cacheGet

(url: URL, method: HttpMethod | "*" = "*", customKey?: string) => {
	response: IResponse<TResponse, TError>,
	expireAt: Date | null
} | undefined

Returns the response object.

cacheClearByKey

(cacheKey: string) => void

Clears every cache entry in a RestClient instance context, matching with the provided cacheKey.

cacheClear

() => void

Clears every cache entry in a RestClient instance context.