From e3d55ab2245159b47dae141bcf57a7d6cf401dd4 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Wed, 7 Jun 2023 10:10:22 +0000 Subject: [PATCH] =?UTF-8?q?chore(release):=201.0.6=20=F0=9F=9A=80=20[skip?= =?UTF-8?q?=20ci]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## [1.0.6](https://github.com/bbeesley/bags-of-cache/compare/v1.0.5...v1.0.6) (2023-06-07) --- CHANGELOG.md | 2 ++ README.md | 24 +++++++++---------- docs/README.md | 24 +++++++++---------- .../classes/cacheing_client.CacheingClient.md | 4 ++-- .../dynamo_client.DynamoCachedClient.md | 4 ++-- docs/modules.md | 4 ++-- docs/modules/cacheing_client.md | 4 ++-- docs/modules/dynamo_client.md | 4 ++-- docs/modules/index.md | 4 ++-- package.json | 2 +- 10 files changed, 39 insertions(+), 37 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5136e822..04c1b937 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,5 @@ +## [1.0.6](https://github.com/bbeesley/bags-of-cache/compare/v1.0.5...v1.0.6) (2023-06-07) + ## [1.0.5](https://github.com/bbeesley/bags-of-cache/compare/v1.0.4...v1.0.5) (2023-06-06) ## [1.0.4](https://github.com/bbeesley/bags-of-cache/compare/v1.0.3...v1.0.4) (2023-06-06) diff --git a/README.md b/README.md index 436e67a1..4eef6e48 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-107](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L16-L107 "Source code on GitHub") +[src/cacheing-client.ts:16-107](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/cacheing-client.ts#L16-L107 "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/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L46-L49 "Source code on GitHub") +[src/cacheing-client.ts:46-49](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/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-71](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L59-L71 "Source code on GitHub") +[src/cacheing-client.ts:59-71](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/cacheing-client.ts#L59-L71 "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:81-85](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L81-L85 "Source code on GitHub") +[src/cacheing-client.ts:81-85](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/cacheing-client.ts#L81-L85 "Source code on GitHub") Sets an item in the cache @@ -116,7 +116,7 @@ Returns **void** ##### stop -[src/cacheing-client.ts:92-94](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L92-L94 "Source code on GitHub") +[src/cacheing-client.ts:92-94](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/cacheing-client.ts#L92-L94 "Source code on GitHub") Empties the cache @@ -124,7 +124,7 @@ Returns **void** ##### createCacheKey -[src/cacheing-client.ts:104-106](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L104-L106 "Source code on GitHub") +[src/cacheing-client.ts:104-106](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/cacheing-client.ts#L104-L106 "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:23-23](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L23-L23 "Source code on GitHub") +[src/dynamo-client.ts:23-23](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/dynamo-client.ts#L23-L23 "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:30-30](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L30-L30 "Source code on GitHub") +[src/dynamo-client.ts:30-30](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/dynamo-client.ts#L30-L30 "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:37-37](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L37-L37 "Source code on GitHub") +[src/dynamo-client.ts:37-37](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/dynamo-client.ts#L37-L37 "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:47-173](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L47-L173 "Source code on GitHub") +[src/dynamo-client.ts:47-173](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/dynamo-client.ts#L47-L173 "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:82-109](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L82-L109 "Source code on GitHub") +[src/dynamo-client.ts:82-109](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/dynamo-client.ts#L82-L109 "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:119-133](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L119-L133 "Source code on GitHub") +[src/dynamo-client.ts:119-133](https://github.com/bbeesley/bags-of-cache/blob/dee64550c2629312221cf2daf947a97a8f75661b/src/dynamo-client.ts#L119-L133 "Source code on GitHub") Sends an arbitrary dynamo query, cacheing the results diff --git a/docs/README.md b/docs/README.md index b47ebd68..92af782b 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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/cacheing-client.ts#L16-L107 "Source code on GitHub") +[src/cacheing-client.ts:16-107](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L16-L107 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/cacheing-client.ts#L46-L49 "Source code on GitHub") +[src/cacheing-client.ts:46-49](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/cacheing-client.ts#L59-L71 "Source code on GitHub") +[src/cacheing-client.ts:59-71](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L59-L71 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/cacheing-client.ts#L81-L85 "Source code on GitHub") +[src/cacheing-client.ts:81-85](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L81-L85 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/cacheing-client.ts#L92-L94 "Source code on GitHub") +[src/cacheing-client.ts:92-94](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L92-L94 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/cacheing-client.ts#L104-L106 "Source code on GitHub") +[src/cacheing-client.ts:104-106](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/cacheing-client.ts#L104-L106 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/dynamo-client.ts#L23-L23 "Source code on GitHub") +[src/dynamo-client.ts:23-23](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L23-L23 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/dynamo-client.ts#L30-L30 "Source code on GitHub") +[src/dynamo-client.ts:30-30](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L30-L30 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/dynamo-client.ts#L37-L37 "Source code on GitHub") +[src/dynamo-client.ts:37-37](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L37-L37 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/dynamo-client.ts#L47-L173 "Source code on GitHub") +[src/dynamo-client.ts:47-173](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L47-L173 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/dynamo-client.ts#L82-L109 "Source code on GitHub") +[src/dynamo-client.ts:82-109](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L82-L109 "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/826e1f69bace3481cb518ddc7c05d4b8e6e2c9cb/src/dynamo-client.ts#L119-L133 "Source code on GitHub") +[src/dynamo-client.ts:119-133](https://github.com/bbeesley/bags-of-cache/blob/8eb98c8f1489cddf859f6f1caee22810d5698c61/src/dynamo-client.ts#L119-L133 "Source code on GitHub") Sends an arbitrary dynamo query, cacheing the results diff --git a/docs/classes/cacheing_client.CacheingClient.md b/docs/classes/cacheing_client.CacheingClient.md index a127f4cf..4a9f4043 100644 --- a/docs/classes/cacheing_client.CacheingClient.md +++ b/docs/classes/cacheing_client.CacheingClient.md @@ -1,6 +1,6 @@ -[@beesley/bags-of-cache](../README.md) / [Modules](../modules.md) / [cacheing-client](../modules/cacheing_client.md) / CacheingClient +[@beesley/bags-of-cache - v1.0.5](../README.md) / [Modules](../modules.md) / [cacheing-client](../modules/cacheing_client.md) / CacheingClient -# CacheingClient +# Class: CacheingClient [cacheing-client](../modules/cacheing_client.md).CacheingClient diff --git a/docs/classes/dynamo_client.DynamoCachedClient.md b/docs/classes/dynamo_client.DynamoCachedClient.md index d2d382f8..f853869d 100644 --- a/docs/classes/dynamo_client.DynamoCachedClient.md +++ b/docs/classes/dynamo_client.DynamoCachedClient.md @@ -1,6 +1,6 @@ -[@beesley/bags-of-cache](../README.md) / [Modules](../modules.md) / [dynamo-client](../modules/dynamo_client.md) / DynamoCachedClient +[@beesley/bags-of-cache - v1.0.5](../README.md) / [Modules](../modules.md) / [dynamo-client](../modules/dynamo_client.md) / DynamoCachedClient -# DynamoCachedClient +# Class: DynamoCachedClient [dynamo-client](../modules/dynamo_client.md).DynamoCachedClient diff --git a/docs/modules.md b/docs/modules.md index bd15e6da..f6351d21 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -1,6 +1,6 @@ -[@beesley/bags-of-cache](README.md) / Modules +[@beesley/bags-of-cache - v1.0.5](README.md) / Modules -# @beesley/bags-of-cache +# @beesley/bags-of-cache - v1.0.5 ## Table of contents diff --git a/docs/modules/cacheing_client.md b/docs/modules/cacheing_client.md index 245510eb..1c8a202a 100644 --- a/docs/modules/cacheing_client.md +++ b/docs/modules/cacheing_client.md @@ -1,6 +1,6 @@ -[@beesley/bags-of-cache](../README.md) / [Modules](../modules.md) / cacheing-client +[@beesley/bags-of-cache - v1.0.5](../README.md) / [Modules](../modules.md) / cacheing-client -# cacheing-client +# Module: cacheing-client ## Table of contents diff --git a/docs/modules/dynamo_client.md b/docs/modules/dynamo_client.md index c7cbe773..19e3784d 100644 --- a/docs/modules/dynamo_client.md +++ b/docs/modules/dynamo_client.md @@ -1,6 +1,6 @@ -[@beesley/bags-of-cache](../README.md) / [Modules](../modules.md) / dynamo-client +[@beesley/bags-of-cache - v1.0.5](../README.md) / [Modules](../modules.md) / dynamo-client -# dynamo-client +# Module: dynamo-client ## Table of contents diff --git a/docs/modules/index.md b/docs/modules/index.md index d5342cc4..89032a82 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -1,6 +1,6 @@ -[@beesley/bags-of-cache](../README.md) / [Modules](../modules.md) / index +[@beesley/bags-of-cache - v1.0.5](../README.md) / [Modules](../modules.md) / index -# index +# Module: index ## Table of contents diff --git a/package.json b/package.json index 819abb95..faa94530 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@beesley/bags-of-cache", - "version": "1.0.5", + "version": "1.0.6", "description": "TTL based in memory cacheing util", "publishConfig": { "access": "public"