diff --git a/CHANGELOG.md b/CHANGELOG.md index e7d9cd66..18d35d1f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,5 @@ +## [1.0.24](https://github.com/bbeesley/bags-of-cache/compare/v1.0.23...v1.0.24) (2023-07-11) + ## [1.0.23](https://github.com/bbeesley/bags-of-cache/compare/v1.0.22...v1.0.23) (2023-07-11) diff --git a/README.md b/README.md index c3ac780b..ce96632f 100644 --- a/README.md +++ b/README.md @@ -72,13 +72,13 @@ const second = await memoised('one'); // this will be returned from the cache #### CacheingClient -[src/cacheing-client.ts:16-108](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L16-L108 "Source code on GitHub") +[src/cacheing-client.ts:16-108](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/cacheing-client.ts#L16-L108 "Source code on GitHub") Base client used to create clients with in memory caches ##### get -[src/cacheing-client.ts:46-49](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L46-L49 "Source code on GitHub") +[src/cacheing-client.ts:46-49](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/cacheing-client.ts#L46-L49 "Source code on GitHub") Gets an item in the cache @@ -90,7 +90,7 @@ Returns **any** {\*} ##### memoise -[src/cacheing-client.ts:59-72](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L59-L72 "Source code on GitHub") +[src/cacheing-client.ts:59-72](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/cacheing-client.ts#L59-L72 "Source code on GitHub") Memoises an arbitrary function using the cache @@ -102,7 +102,7 @@ Returns **any** {T} Memoised version of the function ##### set -[src/cacheing-client.ts:82-86](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L82-L86 "Source code on GitHub") +[src/cacheing-client.ts:82-86](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/cacheing-client.ts#L82-L86 "Source code on GitHub") Sets an item in the cache @@ -116,7 +116,7 @@ Returns **void** ##### stop -[src/cacheing-client.ts:93-95](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L93-L95 "Source code on GitHub") +[src/cacheing-client.ts:93-95](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/cacheing-client.ts#L93-L95 "Source code on GitHub") Empties the cache @@ -124,7 +124,7 @@ Returns **void** ##### createCacheKey -[src/cacheing-client.ts:105-107](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L105-L107 "Source code on GitHub") +[src/cacheing-client.ts:105-107](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/cacheing-client.ts#L105-L107 "Source code on GitHub") Util to serialise stuff to use as a cache key @@ -189,7 +189,7 @@ const item = await client.getItem({ #### emptyResponseCacheTime -[src/dynamo-client.ts:22-22](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L22-L22 "Source code on GitHub") +[src/dynamo-client.ts:22-22](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/dynamo-client.ts#L22-L22 "Source code on GitHub") When we get no items back from a query we will not retry the query within this time (ms) @@ -197,7 +197,7 @@ Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa #### queryConcurrency -[src/dynamo-client.ts:29-29](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L29-L29 "Source code on GitHub") +[src/dynamo-client.ts:29-29](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/dynamo-client.ts#L29-L29 "Source code on GitHub") Limit concurrently sent queries to this value @@ -205,7 +205,7 @@ Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa #### getConcurrency -[src/dynamo-client.ts:36-36](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L36-L36 "Source code on GitHub") +[src/dynamo-client.ts:36-36](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/dynamo-client.ts#L36-L36 "Source code on GitHub") Limit concurrent getItem calls to this value @@ -213,7 +213,7 @@ Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa #### DynamoCachedClient -[src/dynamo-client.ts:46-172](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L46-L172 "Source code on GitHub") +[src/dynamo-client.ts:46-172](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/dynamo-client.ts#L46-L172 "Source code on GitHub") **Extends CacheingClient** @@ -221,7 +221,7 @@ Client for dynamo tables. Makes dynamo requests and caches the results. ##### getItem -[src/dynamo-client.ts:81-108](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L81-L108 "Source code on GitHub") +[src/dynamo-client.ts:81-108](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/dynamo-client.ts#L81-L108 "Source code on GitHub") Gets a single item from the table by key and caches the result @@ -233,7 +233,7 @@ Returns **any** {(Promise\)} ##### query -[src/dynamo-client.ts:118-132](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L118-L132 "Source code on GitHub") +[src/dynamo-client.ts:118-132](https://github.com/bbeesley/bags-of-cache/blob/0ed023324b6e6f470727a5df6d253c7a702d409b/src/dynamo-client.ts#L118-L132 "Source code on GitHub") Sends an arbitrary dynamo query, cacheing the results diff --git a/docs/README.md b/docs/README.md index e90e6554..021977bc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -74,13 +74,13 @@ const second = await memoised('one'); // this will be returned from the cache #### CacheingClient -[src/cacheing-client.ts:16-107](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/cacheing-client.ts#L16-L107 "Source code on GitHub") +[src/cacheing-client.ts:16-108](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L16-L108 "Source code on GitHub") Base client used to create clients with in memory caches ##### get -[src/cacheing-client.ts:46-49](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/cacheing-client.ts#L46-L49 "Source code on GitHub") +[src/cacheing-client.ts:46-49](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L46-L49 "Source code on GitHub") Gets an item in the cache @@ -92,7 +92,7 @@ Returns **any** {\*} ##### memoise -[src/cacheing-client.ts:59-71](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/cacheing-client.ts#L59-L71 "Source code on GitHub") +[src/cacheing-client.ts:59-72](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L59-L72 "Source code on GitHub") Memoises an arbitrary function using the cache @@ -104,7 +104,7 @@ Returns **any** {T} Memoised version of the function ##### set -[src/cacheing-client.ts:81-85](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/cacheing-client.ts#L81-L85 "Source code on GitHub") +[src/cacheing-client.ts:82-86](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L82-L86 "Source code on GitHub") Sets an item in the cache @@ -118,7 +118,7 @@ Returns **void** ##### stop -[src/cacheing-client.ts:92-94](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/cacheing-client.ts#L92-L94 "Source code on GitHub") +[src/cacheing-client.ts:93-95](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L93-L95 "Source code on GitHub") Empties the cache @@ -126,7 +126,7 @@ Returns **void** ##### createCacheKey -[src/cacheing-client.ts:104-106](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/cacheing-client.ts#L104-L106 "Source code on GitHub") +[src/cacheing-client.ts:105-107](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/cacheing-client.ts#L105-L107 "Source code on GitHub") Util to serialise stuff to use as a cache key @@ -191,7 +191,7 @@ const item = await client.getItem({ #### emptyResponseCacheTime -[src/dynamo-client.ts:23-23](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/dynamo-client.ts#L23-L23 "Source code on GitHub") +[src/dynamo-client.ts:22-22](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L22-L22 "Source code on GitHub") When we get no items back from a query we will not retry the query within this time (ms) @@ -199,7 +199,7 @@ Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa #### queryConcurrency -[src/dynamo-client.ts:30-30](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/dynamo-client.ts#L30-L30 "Source code on GitHub") +[src/dynamo-client.ts:29-29](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L29-L29 "Source code on GitHub") Limit concurrently sent queries to this value @@ -207,7 +207,7 @@ Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa #### getConcurrency -[src/dynamo-client.ts:37-37](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/dynamo-client.ts#L37-L37 "Source code on GitHub") +[src/dynamo-client.ts:36-36](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L36-L36 "Source code on GitHub") Limit concurrent getItem calls to this value @@ -215,7 +215,7 @@ Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa #### DynamoCachedClient -[src/dynamo-client.ts:47-173](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/dynamo-client.ts#L47-L173 "Source code on GitHub") +[src/dynamo-client.ts:46-172](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L46-L172 "Source code on GitHub") **Extends CacheingClient** @@ -223,7 +223,7 @@ Client for dynamo tables. Makes dynamo requests and caches the results. ##### getItem -[src/dynamo-client.ts:82-109](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/dynamo-client.ts#L82-L109 "Source code on GitHub") +[src/dynamo-client.ts:81-108](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L81-L108 "Source code on GitHub") Gets a single item from the table by key and caches the result @@ -235,7 +235,7 @@ Returns **any** {(Promise\)} ##### query -[src/dynamo-client.ts:119-133](https://github.com/bbeesley/bags-of-cache/blob/cb30e7836dededa3d0488a3f70bdc62ad51c2fa5/src/dynamo-client.ts#L119-L133 "Source code on GitHub") +[src/dynamo-client.ts:118-132](https://github.com/bbeesley/bags-of-cache/blob/f178cc64355eedd001b6bf6f357321c10fcc99ea/src/dynamo-client.ts#L118-L132 "Source code on GitHub") Sends an arbitrary dynamo query, cacheing the results diff --git a/package.json b/package.json index 9418d42a..89e0c03b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@beesley/bags-of-cache", - "version": "1.0.23", + "version": "1.0.24", "description": "TTL based in memory cacheing util", "publishConfig": { "access": "public"