Interface DestinationCacheInterface

Interface to implement custom destination caching. To use a custom cache, call setDestinationCache and pass a cache instance that implements this interface.

Hierarchy

DestinationCacheInterface

Index

Methods

clear get hasKey set

Methods

clear

clear(): Promise<void>
This can be called to remove all existing entries from the cache.

Returns Promise<void>
- Defined in packages/connectivity/dist/scp-cf/destination/destination-cache.d.ts:35

get

get(key): Promise<undefined | Destination>
This is called when an entry shall be retrieved from the cache.
Parameters
- key: undefined | string
  
  The cache key the item is stored under.
Returns Promise<undefined | Destination>
- Defined in packages/connectivity/dist/scp-cf/destination/destination-cache.d.ts:26

hasKey

hasKey(key): Promise<boolean>
This is called when checking if a given key occurs in the cache.
Parameters
- key: string
  
  The cache key the item should be stored under, if available.
Returns Promise<boolean>
- Defined in packages/connectivity/dist/scp-cf/destination/destination-cache.d.ts:31

set

set(key, item): Promise<void>
This is called when an entry is added to the cache.
Parameters
- key: undefined | string
  
  The cache key to store the item under.
- item: CacheEntry<Destination>
  
  The destination alongside an expiration time to store in the cache.
Returns Promise<void>
- Defined in packages/connectivity/dist/scp-cf/destination/destination-cache.d.ts:21

Copyright Ⓒ 2023 SAP SE or an SAP affiliate company. All rights reserved.