From 2f14847a01dc41d8036ca8d1a5e1451fe70cff13 Mon Sep 17 00:00:00 2001 From: Randall Schmidt Date: Sun, 11 Jul 2021 08:57:39 -0400 Subject: [PATCH] update readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 66a0525..ff0a168 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,8 @@ Options: You can implement a caching delegate yourself. The cache simply needs to be an object that has `set(key, bodyStream, bodyMeta)`, `get(key)`, and `remove(key)` functions. +Check the built-in [MemoryCache](src/classes/caching/memory_cache.js) and [FileSystemCache](src/classes/caching/file_system_cache.js) for examples. + The set function must accept a key (which will be a string), a body stream, and a metadata object (which will be a JSON-serializable JS object). It must store these, and then return an object with a `bodyStream` property, containing a fresh, unread stream of the body content, as well as a `metaData` property, containing the same metaData that was passed in. The get function should accept a key and return undefined if no cached value is found, or else an object with a `bodyStream` property, containing a stream of the body content, as well as a `metaData` property, containing the metadata that was stored via the `set(key, bodyStream, bodyMeta)` function.