---
product: Chilkat
product_version: 11.7.0
language: js
language_label: JavaScript
class: Cache
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/jsCacheRef.html
---
# Chilkat Cache — JavaScript — v11.7.0

> Chilkat 11.7.0 · language=js · class=Cache
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Cache.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/guide.md`.

## Purpose

**Store, retrieve, expire, and clean up cached text or binary data on disk.**

`Chilkat.Cache` is a disk-based cache class for storing and retrieving text or binary items by unique key. It provides configurable cache roots, optional multi-level directory layout, expiration metadata, ETag metadata, cache lookup, fetch-status properties, expiration updates, and cleanup methods for deleting individual items, expired items, older items, or the entire cache.

**Key-based storage**

Store and retrieve cached items by unique key, without the application needing to manage the underlying cache filenames directly.

**Text and binary data**

Cache strings, byte data, files, or Chilkat buffer objects depending on the data form used by the application.

**Expiration control**

Associate cached items with expiration times, update expiration metadata, and check whether cached content is still usable.

**ETag metadata**

Store and retrieve ETag values for workflows that need HTTP-style cache validation or conditional re-fetch logic.

**Configurable layout**

Choose the cache root directory and use an optional multi-level directory structure to avoid too many files in a single folder.

**Cleanup operations**

Delete a single cached item, remove expired items, remove older items, or clear the entire cache when needed.

**Common pattern:** Configure the cache root, choose the key used to identify each item, check whether a valid cached copy exists, fetch or regenerate the content when needed, store it with expiration and optional ETag metadata, and periodically clean up expired or old cached items.

For an extended overview, see [Cache Class Overview](https://www.chilkatsoft.com/cache_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

Note: This is intended for running within a [Chilkat.Js embedded JavaScript engine](https://www.chilkatsoft.com/chilkat_javascript_engine.asp).

```
var obj = new CkCache();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in JavaScript.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `LastErrorHtml` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `VerboseLogging` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `LastEtagFetched` | property, read-only | `LastEtagFetched` |
| `LastExpirationFetchedStr` | property, read-only | `LastExpirationFetchedStr` |
| `LastHitExpired` | property, read-only | `LastHitExpired` |
| `LastKeyFetched` | property, read-only | `LastKeyFetched` |
| `Level` | property, read/write | `Level` |
| `NumRoots` | property, read-only | `NumRoots` |
| `AddRoot` | method | `AddRoot(path);` |
| `DeleteAll` | method | `var intVal = DeleteAll();` |
| `DeleteAllExpired` | method | `var intVal = DeleteAllExpired();` |
| `DeleteFromCache` | method | `var success = DeleteFromCache(key);` |
| `DeleteOlderDt` | method | `var intVal = DeleteOlderDt(dt);` |
| `DeleteOlderStr` | method | `var intVal = DeleteOlderStr(dateTimeStr);` |
| `FetchBd` | method | `var success = FetchBd(key, bd);` |
| `FetchSb` | method | `var success = FetchSb(key, sb);` |
| `FetchText` | method | `var strVal = FetchText(key);` |
| `GetEtag` | method | `var strVal = GetEtag(key);` |
| `GetExpirationStr` | method | `var strVal = GetExpirationStr(url);` |
| `GetFilename` | method | `var strVal = GetFilename(key);` |
| `GetRoot` | method | `var strVal = GetRoot(index);` |
| `IsCached` | method | `var boolVal = IsCached(key);` |
| `SaveBd` | method | `var success = SaveBd(key, expiration, etag, bd);` |
| `SaveTextDt` | method | `var success = SaveTextDt(key, expireDateTime, eTag, itemTextData);` |
| `SaveTextNoExpire` | method | `var success = SaveTextNoExpire(key, eTag, itemTextData);` |
| `SaveTextStr` | method | `var success = SaveTextStr(key, expireDateTime, eTag, itemTextData);` |
| `UpdateExpirationDt` | method | `var success = UpdateExpirationDt(key, expireDateTime);` |
| `UpdateExpirationStr` | method | `var success = UpdateExpirationStr(key, expireDateTime);` |

## Properties

### Cache.LastEtagFetched

`Chilkat 11.7.0 · js · Cache · LastEtagFetched · property · read-only`

```javascript
LastEtagFetched
```

· `string`, `read-only`

Returns the ETag metadata associated with the most recently fetched cache item. An empty string means that the fetched item has no stored ETag.

**Read after a fetch:** This property describes the item returned by the most recent successful fetch operation, such as `FetchBd`, `FetchSb`, or `FetchText`.

**ETags are opaque metadata:** The cache stores and returns the string but does not interpret it. Applications commonly use an HTTP ETag with conditional requests such as `If-None-Match`.

### Cache.LastExpirationFetchedStr

`Chilkat 11.7.0 · js · Cache · LastExpirationFetchedStr · property · read-only`

```javascript
LastExpirationFetchedStr
```

· `string`, `read-only`

Returns the expiration date and time stored for the most recently fetched cache item, formatted as an RFC 822-style Internet date. An empty string represents an item with no expiration date.

**Expiration is metadata:** Fetching an expired item is still possible. Read `LastHitExpired` after the fetch to determine whether the returned entry is stale.

### Cache.LastHitExpired

`Chilkat 11.7.0 · js · Cache · LastHitExpired · property · read-only`

```javascript
LastHitExpired
```

· `boolean`, `read-only`

Returns `true` when the expiration time of the most recently fetched item is earlier than the current system date and time; otherwise returns `false`.

**Expired does not mean deleted:** Expiration marks an entry as stale. The file remains in the cache until it is replaced or removed by methods such as `DeleteAllExpired` or `DeleteFromCache`.

### Cache.LastKeyFetched

`Chilkat 11.7.0 · js · Cache · LastKeyFetched · property · read-only`

```javascript
LastKeyFetched
```

· `string`, `read-only`

Returns the application-defined key associated with the most recently fetched cache item.

**Keys are not limited to URLs:** A canonicalized URL is a common key for cached web content, but any unique string may be used. Reusing a key causes a save operation to replace the existing item for that key.

### Cache.Level

`Chilkat 11.7.0 · js · Cache · Level · property · read/write`

```javascript
Level
```

· `int`

Gets or sets the number of directory levels used beneath each cache root. Valid values are `0`, `1`, and `2`.

| Value | Directory layout |
| :--- | :--- |
| `0` | All cache files are stored directly in the cache root. |
| `1` | Files are distributed among 256 first-level directories named `0` through `255`. |
| `2` | Files are distributed through two levels of 256 directories, allowing as many as 65,536 leaf directories per root. |

**Configure before use:** Use the same level when reopening an existing cache. Changing the layout does not reorganize previously stored files and can prevent the object from locating them through their keys.

### Cache.NumRoots

`Chilkat 11.7.0 · js · Cache · NumRoots · property · read-only`

```javascript
NumRoots
```

· `int`, `read-only`

Returns the number of cache-root directories that have been registered by calling `AddRoot`.

**Multiple roots:** A cache may span more than one directory or storage device. Configure the same root set when reopening a persistent cache so previously stored items remain discoverable.

## Methods

### Cache.AddRoot

`Chilkat 11.7.0 · js · Cache · AddRoot · method`

```javascript
AddRoot(path);
```

· return: `undefined`  
· path: `string`

Adds `path` as a root directory for the disk cache. Call this method once for each root that should participate in the cache.

For example, a cache distributed across `D:\cacheRoot`, `E:\cacheRoot`, and `F:\cacheRoot` is configured by calling this method three times.

**Use dedicated writable directories:** Cache cleanup methods can delete cache files beneath every configured root. Do not mix unrelated application files into a cache root.

**Persistent configuration:** Recreate the same roots and `Level` setting before accessing a cache created by an earlier process or application run.

### Cache.DeleteAll

`Chilkat 11.7.0 · js · Cache · DeleteAll · method`

```javascript
var intVal = DeleteAll();
```

· return: `int`

Deletes every cache item from all configured roots and returns the number of cache files removed. Multi-level subdirectories are retained.

**Destructive operation:** This cannot be limited to a key prefix or reversed. Use cache roots dedicated to Chilkat cache data.

### Cache.DeleteAllExpired

`Chilkat 11.7.0 · js · Cache · DeleteAllExpired · method`

```javascript
var intVal = DeleteAllExpired();
```

· return: `int`

Deletes all cache items whose stored expiration time is earlier than the current system time and returns the number of files removed.

**Non-expiring entries remain:** Items saved without an expiration date are not removed by this method.

### Cache.DeleteFromCache

`Chilkat 11.7.0 · js · Cache · DeleteFromCache · method`

```javascript
var success = DeleteFromCache(key);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `string`

Deletes the cache item identified by `key`.

| Return value | Meaning |
| :--- | :--- |
| `true` | The item was deleted, or no item existed for the key. |
| `false` | The item exists but could not be deleted, for example because of a filesystem permission or sharing error. |

**Idempotent deletion:** A missing key is not treated as an error, which makes it safe to call this method when the application merely wants to ensure that an item is absent.

Returns true for success, false for failure.

### Cache.DeleteOlderDt

`Chilkat 11.7.0 · js · Cache · DeleteOlderDt · method`

```javascript
var intVal = DeleteOlderDt(dt);
```

· return: `int`  
· dt: `CkDateTime`

Deletes cache items older than the cutoff date and time supplied in `dt`.

Returns the number of cache files deleted, or `-1` if an error occurs.

**Different from expiration cleanup:** Use `DeleteAllExpired` when the decision should be based specifically on each item's expiration metadata.

### Cache.DeleteOlderStr

`Chilkat 11.7.0 · js · Cache · DeleteOlderStr · method`

```javascript
var intVal = DeleteOlderStr(dateTimeStr);
```

· return: `int`  
· dateTimeStr: `string`

Deletes cache items older than the cutoff date and time supplied in `dateTimeStr` as an RFC 822-style Internet date string.

Returns the number of cache files deleted, or `-1` if an error occurs.

**Date format:** A typical value is `Mon, 03 Aug 2026 12:00:00 GMT`. Use `DeleteOlderDt` when the cutoff is already available as a `CkDateTime`.

### Cache.FetchBd

`Chilkat 11.7.0 · js · Cache · FetchBd · method · since 9.5.0.91`

```javascript
var success = FetchBd(key, bd);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `string`  
· bd: `CkBinData`

Retrieves the binary item identified by `key` and loads its bytes into the `BinData` object supplied in `bd`.

The key is application-defined, may contain any characters, and must uniquely identify the intended item.

**Check the return value:** Use the destination only when this method returns `true`. A failed lookup or filesystem error returns `false`.

**Freshness:** A successful fetch may return an expired item. Read `LastHitExpired` immediately afterward when stale data must not be used.

Returns true for success, false for failure.

### Cache.FetchSb

`Chilkat 11.7.0 · js · Cache · FetchSb · method · since 9.5.0.91`

```javascript
var success = FetchSb(key, sb);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `string`  
· sb: `CkStringBuilder`

Retrieves the text item identified by `key` and loads its content into the `StringBuilder` supplied in `sb`.

The key is application-defined, may contain any characters, and must uniquely identify the intended item.

**Check the return value:** Use the destination only when this method returns `true`. A failed lookup or filesystem error returns `false`.

**Freshness:** A successful fetch may return an expired item. Read `LastHitExpired` immediately afterward when stale data must not be used.

Returns true for success, false for failure.

### Cache.FetchText

`Chilkat 11.7.0 · js · Cache · FetchText · method`

```javascript
var strVal = FetchText(key);
```

· return: `string`  
· key: `string`

Retrieves the text item identified by `key` and returns its string content.

The key is application-defined, may contain any characters, and must uniquely identify the intended item.

**Freshness is separate:** A successful fetch can return an expired entry. Read `LastHitExpired` immediately afterward when the application requires only fresh data.

Returns `null` on failure

### Cache.GetEtag

`Chilkat 11.7.0 · js · Cache · GetEtag · method`

```javascript
var strVal = GetEtag(key);
```

· return: `string`  
· key: `string`

Returns the ETag metadata stored with the cache item identified by `key`.

**Opaque value:** Chilkat does not parse or validate the ETag. An application may store any auxiliary string here, although HTTP entity tags are the common use case.

Returns `null` on failure

### Cache.GetExpirationStr

`Chilkat 11.7.0 · js · Cache · GetExpirationStr · method`

```javascript
var strVal = GetExpirationStr(url);
```

· return: `string`  
· url: `string`

Returns the expiration date and time stored for the item identified by `url`, formatted as an RFC 822-style Internet date string.

**Argument name:** Some language bindings name `url` `url` for historical reasons. It is the cache key and does not need to be a URL.

**No-expiration entries:** An empty stored expiration represents an item that does not expire automatically.

Returns `null` on failure

### Cache.GetFilename

`Chilkat 11.7.0 · js · Cache · GetFilename · method`

```javascript
var strVal = GetFilename(key);
```

· return: `string`  
· key: `string`

Returns the absolute filesystem path of the cache file associated with `key`.

**Implementation detail:** Treat the returned path as diagnostic information. Applications should normally read, update, and delete entries through the `Cache` API rather than modifying cache files directly.

Returns `null` on failure

### Cache.GetRoot

`Chilkat 11.7.0 · js · Cache · GetRoot · method`

```javascript
var strVal = GetRoot(index);
```

· return: `string`  
· index: `int`

Returns the directory path of the cache root at zero-based `index`. Valid indexes range from `0` through `NumRoots - 1`.

Returns `null` on failure

### Cache.IsCached

`Chilkat 11.7.0 · js · Cache · IsCached · method`

```javascript
var boolVal = IsCached(key);
```

· return: `boolean`  
· key: `string`

Returns `true` if an item exists for `key`, or `false` if the key is not present.

**Presence is not freshness:** This method does not imply that the entry is unexpired. Fetch the item and examine `LastHitExpired`, or read its expiration metadata, when freshness matters.

### Cache.SaveBd

`Chilkat 11.7.0 · js · Cache · SaveBd · method · since 11.0.0`

```javascript
var success = SaveBd(key, expiration, etag, bd);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `string`  
· expiration: `string`  
· etag: `string`  
· bd: `CkBinData`

Stores the contents of `bd` as binary cache data under `key`. If the key already exists, its data and metadata are replaced.

| Argument | Purpose |
| :--- | :--- |
| `key` | The unique application-defined cache key. |
| `expiration` | Expiration as an RFC 822-style Internet date string. Pass an empty string for no expiration. |
| `etag` | Optional ETag or application metadata. Pass an empty string when unused. |
| `bd` | The `BinData` containing the bytes to save. |

**Expiration is not automatic deletion:** An expired item remains present until it is replaced or explicitly removed. This permits stale-while-revalidate workflows but requires the application to check freshness.

Returns true for success, false for failure.

### Cache.SaveTextDt

`Chilkat 11.7.0 · js · Cache · SaveTextDt · method`

```javascript
var success = SaveTextDt(key, expireDateTime, eTag, itemTextData);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `string`  
· expireDateTime: `CkDateTime`  
· eTag: `string`  
· itemTextData: `string`

Stores `itemTextData` as a text cache item under `key`, with the expiration date and time supplied in `expireDateTime`. If the key already exists, its data and metadata are replaced.

`eTag` is optional ETag or application metadata and may be an empty string. The key may contain any characters and may be any length, but it must uniquely identify the item.

**Expiration does not delete:** After the expiration time passes, the entry remains on disk and can still be fetched. Use `LastHitExpired` to detect staleness and a deletion method to remove it.

Returns true for success, false for failure.

### Cache.SaveTextNoExpire

`Chilkat 11.7.0 · js · Cache · SaveTextNoExpire · method`

```javascript
var success = SaveTextNoExpire(key, eTag, itemTextData);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `string`  
· eTag: `string`  
· itemTextData: `string`

Stores `itemTextData` as a non-expiring text cache item under `key`. If the key already exists, its data and metadata are replaced.

`eTag` is optional ETag or application metadata and may be an empty string.

Returns true for success, false for failure.

### Cache.SaveTextStr

`Chilkat 11.7.0 · js · Cache · SaveTextStr · method`

```javascript
var success = SaveTextStr(key, expireDateTime, eTag, itemTextData);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `string`  
· expireDateTime: `string`  
· eTag: `string`  
· itemTextData: `string`

Stores `itemTextData` as a text cache item under `key`, with `expireDateTime` providing the expiration time as an RFC 822-style Internet date string. If the key already exists, its data and metadata are replaced.

`eTag` is optional ETag or application metadata and may be empty.

**Date alternatives:** Use `SaveTextDt` when the expiration is available as a `CkDateTime`, or `SaveTextNoExpire` for an entry without expiration.

Returns true for success, false for failure.

### Cache.UpdateExpirationDt

`Chilkat 11.7.0 · js · Cache · UpdateExpirationDt · method`

```javascript
var success = UpdateExpirationDt(key, expireDateTime);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `string`  
· expireDateTime: `CkDateTime`

Replaces the expiration date and time of the cache item identified by `key` with the `CkDateTime` value supplied in `expireDateTime`. The cached data and ETag are unchanged.

**Existing item required:** This method updates metadata; it does not create a new cache entry when the key is absent.

Returns true for success, false for failure.

### Cache.UpdateExpirationStr

`Chilkat 11.7.0 · js · Cache · UpdateExpirationStr · method`

```javascript
var success = UpdateExpirationStr(key, expireDateTime);
```

· return: `boolean`; `true` for success, `false` for failure  
· key: `string`  
· expireDateTime: `string`

Replaces the expiration date and time of the cache item identified by `key` with the RFC 822-style Internet date string supplied in `expireDateTime`. The cached data and ETag are unchanged.

**Argument name:** Some language bindings name `key` `url`; it is the cache key and does not need to be a URL. Use `UpdateExpirationDt` for a `CkDateTime` value.

Returns true for success, false for failure.

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/BinData.md), [`CkDateTime`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/CkDateTime.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/StringBuilder.md)