Class Cache

Cache functions result in your Edge-first applications.

Index

Constructors

Properties

Accessors

Methods

fetch getPrefixedKey purge

Constructors

constructor

new Cache(kv: KVNamespace<string>): Cache
Parameters
- kv: KVNamespace<string>
Returns Cache
- Defined in src/lib/cache/cache.ts:40

Properties

`Protected`kv

kv: KVNamespace<string>

`Protected`prefix

prefix: string = "cache"

Accessors

binding

get binding(): KVNamespace<string>
A read-only property that gives you the KVNamespace used by the Cache object.

The namespace can be used to access the KVNamespace directly in case you need to integrate with it.

Returns KVNamespace<string>
Example
```
let namespace = cache().binding;
```
- Defined in src/lib/cache/cache.ts:49

Methods

fetch

fetch<T extends Jsonifiable>(key: string, cb: CallbackFunction<T>): Promise<T>
The cache().fetch method is used to get a value from the cache or calculate it if it's not there.

The function expects the key, the TTL, and a function that will be called to calculate the value if it's not in the cache.
Type Parameters
- T extends Jsonifiable
Parameters
- key: string
  The cache key to use, always prefixed by cache:
- cb: CallbackFunction<T>
Returns Promise<T>
Example
```
let ONE_HOUR_IN_SECONDS = 3600;

let value = await cache().fetch("key", ONE_HOUR_IN_SECONDS, async () => {
  // do something expensive and return the value
});

// The TTL is optional, it defaults to 60 seconds if not provided.
```
Example
```
await cache().fetch("another-key", async () => {
  // The TTL is optional, it defaults to 60 seconds
});
```
- Defined in src/lib/cache/cache.ts:77
fetch<T extends Jsonifiable>(
    key: string,
    ttl: number,
    callback: CallbackFunction<T>,
): Promise<T>
The cache().fetch method is used to get a value from the cache or calculate it if it's not there.

The function expects the key, the TTL, and a function that will be called to calculate the value if it's not in the cache.
Type Parameters
- T extends Jsonifiable
Parameters
- key: string
  The cache key to use, always prefixed by cache:
- ttl: number
  The time-to-live for the cache, in seconds
- callback: CallbackFunction<T>
  The function to call if the cache is not found
Returns Promise<T>
Example
```
let ONE_HOUR_IN_SECONDS = 3600;

let value = await cache().fetch("key", ONE_HOUR_IN_SECONDS, async () => {
  // do something expensive and return the value
});

// The TTL is optional, it defaults to 60 seconds if not provided.
```
Example
```
await cache().fetch("another-key", async () => {
  // The TTL is optional, it defaults to 60 seconds
});
```
- Defined in src/lib/cache/cache.ts:81

`Protected`getPrefixedKey

getPrefixedKey(key: string): string
Parameters
- key: string
Returns string
- Defined in src/lib/cache/cache.ts:116

purge

purge(key: string): Promise<void>
The cache().purge method is used to remove a key from the cache.
Parameters
- key: string
  The cache key to delete, always prefixed by cache:
Returns Promise<void>
Example
```
cache().purge("key");
```
- Defined in src/lib/cache/cache.ts:112