Skip to content

Commit

Permalink
feat(adapters): Memcached adapter based on "memcached" module
Browse files Browse the repository at this point in the history 
build(prettier): added Prettier
refactor: refactored project structure to be more like other community projects

BREAKING CHANGE:
* Removed tag reading optimizations. It is not intended to use caches in this way.
* The "del" interface has been changed to be more convenient.
  • Loading branch information
@drwatsno
drwatsno committed Mar 15, 2020
1 parent fa88918 commit 9b4aa04
Show file tree
Hide file tree
Showing 104 changed files with 3,148 additions and 3,824 deletions.
3 changes: 3 additions & 0 deletions .prettierrc.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
trailingComma: "es5"
tabWidth: 2
printWidth: 110
2 changes: 1 addition & 1 deletion docs/api/assets/js/search.js
View file

Large diffs are not rendered by default.

44 changes: 22 additions & 22 deletions docs/api/classes/basemanager.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,10 @@ <h3>Implements</h3>
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<section class="tsd-index-section tsd-is-private-protected">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="basemanager.html#constructor" class="tsd-kind-icon">constructor</a></li>
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-protected"><a href="basemanager.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private-protected">
Expand All @@ -122,19 +122,19 @@ <h3>Methods</h3>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<h3><span class="tsd-flag ts-flagProtected">Protected</span> constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">new <wbr>Base<wbr>Manager<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/manageroptions.html" class="tsd-signature-type">ManagerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="basemanager.html" class="tsd-signature-type">BaseManager</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/base.ts#L25">src/managers/base.ts:25</a></li>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/BaseManager.ts#L19">src/managers/BaseManager.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -156,7 +156,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> locked<wbr>Key<wbr>
<div class="tsd-signature tsd-kind-icon">locked<wbr>Key<wbr>Retrieve<wbr>Strategies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/lockedkeyretrievestrategy.html" class="tsd-signature-type">LockedKeyRetrieveStrategy</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/base.ts#L47">src/managers/base.ts:47</a></li>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/BaseManager.ts#L44">src/managers/BaseManager.ts:44</a></li>
</ul>
</aside>
</section>
Expand All @@ -166,7 +166,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> logger</h3>
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="../interfaces/logger.html" class="tsd-signature-type">Logger</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/base.ts#L49">src/managers/base.ts:49</a></li>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/BaseManager.ts#L46">src/managers/BaseManager.ts:46</a></li>
</ul>
</aside>
</section>
Expand All @@ -176,7 +176,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> storage</h3>
<div class="tsd-signature tsd-kind-icon">storage<span class="tsd-signature-symbol">:</span> <a href="../interfaces/storage.html" class="tsd-signature-type">Storage</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/base.ts#L45">src/managers/base.ts:45</a></li>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/BaseManager.ts#L42">src/managers/BaseManager.ts:42</a></li>
</ul>
</aside>
</section>
Expand All @@ -194,7 +194,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/manager.html">Manager</a>.<a href="../interfaces/manager.html#get">get</a></p>
<ul>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/base.ts#L51">src/managers/base.ts:51</a></li>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/BaseManager.ts#L48">src/managers/BaseManager.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -229,7 +229,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Locked<wbr>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/base.ts#L92">src/managers/base.ts:92</a></li>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/BaseManager.ts#L98">src/managers/BaseManager.ts:98</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -246,22 +246,22 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/lockedkeyretrievest
<a name="istagsoutdated" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> is<wbr>Tags<wbr>Outdated</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">is<wbr>Tags<wbr>Outdated<span class="tsd-signature-symbol">(</span>recordArrayTags<span class="tsd-signature-symbol">: </span><a href="../interfaces/storagerecordtag.html" class="tsd-signature-type">StorageRecordTag</a><span class="tsd-signature-symbol">[]</span>, actualArrayTags<span class="tsd-signature-symbol">: </span><a href="../interfaces/storagerecordtag.html" class="tsd-signature-type">StorageRecordTag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-signature tsd-kind-icon">is<wbr>Tags<wbr>Outdated<span class="tsd-signature-symbol">(</span>recordArrayTags<span class="tsd-signature-symbol">: </span><a href="../interfaces/tag.html" class="tsd-signature-type">Tag</a><span class="tsd-signature-symbol">[]</span>, actualArrayTags<span class="tsd-signature-symbol">: </span><a href="../interfaces/tag.html" class="tsd-signature-type">Tag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/base.ts#L56">src/managers/base.ts:56</a></li>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/BaseManager.ts#L56">src/managers/BaseManager.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>recordArrayTags: <a href="../interfaces/storagerecordtag.html" class="tsd-signature-type">StorageRecordTag</a><span class="tsd-signature-symbol">[]</span></h5>
<h5>recordArrayTags: <a href="../interfaces/tag.html" class="tsd-signature-type">Tag</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>actualArrayTags: <a href="../interfaces/storagerecordtag.html" class="tsd-signature-type">StorageRecordTag</a><span class="tsd-signature-symbol">[]</span></h5>
<h5>actualArrayTags: <a href="../interfaces/tag.html" class="tsd-signature-type">Tag</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
Expand All @@ -272,14 +272,14 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
<a name="set" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> set</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><a href="../globals.html#storagerecordvalue" class="tsd-signature-type">StorageRecordValue</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/writeoptions.html" class="tsd-signature-type">WriteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><a href="../globals.html#recordvalue" class="tsd-signature-type">RecordValue</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/writeoptions.html" class="tsd-signature-type">WriteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/manager.html">Manager</a>.<a href="../interfaces/manager.html#set">set</a></p>
<ul>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/base.ts#L54">src/managers/base.ts:54</a></li>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/BaseManager.ts#L54">src/managers/BaseManager.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -288,7 +288,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>key: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>value: <a href="../globals.html#storagerecordvalue" class="tsd-signature-type">StorageRecordValue</a></h5>
<h5>value: <a href="../globals.html#recordvalue" class="tsd-signature-type">RecordValue</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/writeoptions.html" class="tsd-signature-type">WriteOptions</a></h5>
Expand All @@ -308,7 +308,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> update<wbr>Cache<wb
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/base.ts#L63">src/managers/base.ts:63</a></li>
<li>Defined in <a href="https://github.com/TinkoffCreditSystems/cachalot/blob/master/src/managers/BaseManager.ts#L63">src/managers/BaseManager.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -347,7 +347,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class="current tsd-kind-class">
<a href="basemanager.html" class="tsd-kind-icon">Base<wbr>Manager</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
<a href="basemanager.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
Expand Down Expand Up @@ -447,4 +447,4 @@ <h2>Legend</h2>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>
</html>

0 comments on commit 9b4aa04

Please sign in to comment.