react-suspense-cache

Index

Enumerations

StorageAccess

Strategies Classes

Plugins Classes

Other Classes

Interfaces

Type aliases

Core Functions

createResource

Other Functions

Object literals

Type aliases

Fetcher

Fetcher<T>: (...args: StorageRequest) => Promise<T>

A asynchronous function that receives StorageRequest and resolves to a data

Type parameters

T

type of the data to be resolved.

Type declaration

- (...args: StorageRequest): Promise<T>
- Parameters
  - Rest ...args: StorageRequest
  Returns Promise<T>

Key

Key: string

The type of the value to be returned by the KeyFactory.

This key is used to indicate the cache slot for both the resource and the global cache.

KeyFactory

KeyFactory: (...args: StorageRequest) => Key

A function that receives [[Storagerequest]] and returns a Key.

Type declaration

- (...args: StorageRequest): Key
- Parameters
  - Rest ...args: StorageRequest
  Returns Key

RequestWillFetchParam

RequestWillFetchParam<T>: ResourceHandlerParam<T>

An object to be received by the ResourcePlugin's "requestWillFetch" property.

Type parameters

T

type of the cache data

ResponseData

ResponseData<T>: ResponseFailure | ResponseSuccess<T>

Cache response types

Type parameters

T

type of the resolved value.

StorageRequest

StorageRequest: any[]

An array of values to be received by the KeyFactory and the data fetcher.

Core Functions

createResource

createResource<T, Params>(__namedParameters: { cacheName: undefined | string; fetcher: (...args: StorageRequest) => Promise<T>; keyFactory: (...args: StorageRequest) => Key; revalidateOnVisibility: undefined | false | true; strategy: undefined | ResourceHandler<T>; updateOnVisibility: undefined | false | true }): Resource<T, Params>

- Defined in src/resource.tsx:44
Constructs a React resource for Suspense components.

Type parameters
- T
  
  the type of the data that flows in the resource.
- Params: StorageRequest
  
  a unified type for the StorageRequest
Parameters
- __namedParameters: { cacheName: undefined | string; fetcher: (...args: StorageRequest) => Promise<T>; keyFactory: (...args: StorageRequest) => Key; revalidateOnVisibility: undefined | false | true; strategy: undefined | ResourceHandler<T>; updateOnVisibility: undefined | false | true }
  - cacheName: undefined | string
  - fetcher: (...args: StorageRequest) => Promise<T>
    - - (...args: StorageRequest): Promise<T>
      - Parameters
        
        Rest ...args: StorageRequest
        
        Returns Promise<T>
  - keyFactory: (...args: StorageRequest) => Key
    - - (...args: StorageRequest): Key
      - Parameters
        
        Rest ...args: StorageRequest
        
        Returns Key
  - revalidateOnVisibility: undefined | false | true
  - strategy: undefined | ResourceHandler<T>
  - updateOnVisibility: undefined | false | true
Returns Resource<T, Params>

Other Functions

cacheData

cacheData<T>(param: ResourceHandlerParam<T>, response: ResponseData<T>, plugins: ResourcePlugin<T>[]): Promise<void>

- Defined in src/utils/plugin-handler.ts:240
Writes the data to the cache

Calls cacheKeyWillBeUsed, cacheWillUpdate and cacheDidUpdate stages. Also calls the matchData stages.

Type parameters
- T
Parameters
- param: ResourceHandlerParam<T>
  
  original parameter received from the ResourceHandler
- response: ResponseData<T>
- plugins: ResourcePlugin<T>[]
  
  Array of ResourcePlugin
Returns Promise<void>

fetchData

fetchData<T>(param: ResourceHandlerParam<T>, plugins: ResourcePlugin<T>[]): Promise<ResponseData<T>>

- Defined in src/utils/plugin-handler.ts:101
Fetches data from the fetcher (provided by the params).

Calls requestWillFetch, fetchDidSucceed and fetchDidFail stages.

Type parameters
- T
Parameters
- param: ResourceHandlerParam<T>
  
  original parameter received from the ResourceHandler
- plugins: ResourcePlugin<T>[]
  
  Array of ResourcePlugin
Returns Promise<ResponseData<T>>

matchData

matchData<T>(param: ResourceHandlerParam<T>, plugins: ResourcePlugin<T>[]): Promise<Optional<ResponseData<T>>>

- Defined in src/utils/plugin-handler.ts:202
Reads data from the cache.

Calls cacheKeyWillBeUsed and cachedResponseWillBeUsed stages.

Type parameters
- T
Parameters
- param: ResourceHandlerParam<T>
  
  original parameter received from the ResourceHandler
- plugins: ResourcePlugin<T>[]
  
  Array of ResourcePlugin
Returns Promise<Optional<ResponseData<T>>>

Object literals

Const RESOURCE_CACHE

RESOURCE_CACHE: object

delete

delete(cacheName: string, key: Key): void

- Defined in src/utils/resource-cache.ts:65
Parameters
- cacheName: string
- key: Key
Returns void

get

get<T>(cacheName: string, key: Key): ResourceCache<T> | undefined

- Defined in src/utils/resource-cache.ts:43
Type parameters
- T
Parameters
- cacheName: string
- key: Key
Returns ResourceCache<T> | undefined

has

has(cacheName: string, key: Key): boolean

- Defined in src/utils/resource-cache.ts:34
Parameters
- cacheName: string
- key: Key
Returns boolean

set

set<T>(cacheName: string, key: Key, value: ResourceCache<T>): void

- Defined in src/utils/resource-cache.ts:52
Type parameters
- T
Parameters
- cacheName: string
- key: Key
- value: ResourceCache<T>
Returns void

Const STRATEGY_CACHE

STRATEGY_CACHE: object

get

get<T>(cacheName: string, key: Key): ResponseData<T> | undefined

- Defined in src/utils/strategy-cache.ts:54
Gets the cached data from the given cache and key

Type parameters
- T
  
  the type of the cached value
Parameters
- cacheName: string
  
  the name of the cache to access to
- key: Key
  
  key of the data to check for
Returns ResponseData<T> | undefined

has

has(cacheName: string, key: Key): boolean

- Defined in src/utils/strategy-cache.ts:39
Checks if the GlobalCache has the given key of cache occupied

Parameters
- cacheName: string
  
  the name of the cache to access to
- key: Key
  
  key of the data to check for
Returns boolean

set

set<T>(cacheName: string, key: Key, value: ResponseData<T>): void

- Defined in src/utils/strategy-cache.ts:70
Sets the data to be cached for the given cache and key

Type parameters
- T
  
  the type of the value to be cached with.
Parameters
- cacheName: string
  
  the name of the cache to access to
- key: Key
  
  key of the data to check for
- value: ResponseData<T>
  
  value to be cached
Returns void

Index

Enumerations

Strategies Classes

Plugins Classes

Other Classes

Interfaces

Type aliases

Core Functions

Other Functions

Object literals

Type aliases

Fetcher

Type parameters

T

Type declaration

Parameters

Rest ...args: StorageRequest

Returns Promise<T>

Key

KeyFactory

Type declaration

Parameters

Rest ...args: StorageRequest

Returns Key

RequestWillFetchParam

Type parameters

T

ResponseData

Type parameters

T

StorageRequest

Core Functions

createResource

Type parameters

T

Params: StorageRequest

Parameters

__namedParameters: { cacheName: undefined | string; fetcher: (...args: StorageRequest) => Promise<T>; keyFactory: (...args: StorageRequest) => Key; revalidateOnVisibility: undefined | false | true; strategy: undefined | ResourceHandler<T>; updateOnVisibility: undefined | false | true }

cacheName: undefined | string

fetcher: (...args: StorageRequest) => Promise<T>

Parameters

Rest ...args: StorageRequest

Returns Promise<T>

keyFactory: (...args: StorageRequest) => Key

Parameters

Rest ...args: StorageRequest

Returns Key

revalidateOnVisibility: undefined | false | true

strategy: undefined | ResourceHandler<T>

updateOnVisibility: undefined | false | true

Returns Resource<T, Params>

Other Functions

cacheData

Type parameters

T

Parameters

param: ResourceHandlerParam<T>

response: ResponseData<T>

plugins: ResourcePlugin<T>[]

Returns Promise<void>

fetchData

Type parameters

T

Parameters

param: ResourceHandlerParam<T>

plugins: ResourcePlugin<T>[]

Returns Promise<ResponseData<T>>

matchData

Type parameters

T

Parameters

param: ResourceHandlerParam<T>

plugins: ResourcePlugin<T>[]

Returns Promise<Optional<ResponseData<T>>>

Object literals

Const RESOURCE_CACHE

delete

Parameters

cacheName: string

key: Key