lemon-core 2.2.20 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (230) hide show
  1. package/dist/common/test-helper.js +1 -1
  2. package/dist/common/test-helper.js.map +1 -1
  3. package/dist/controllers/dummy-controller.js.map +1 -1
  4. package/dist/cores/api-service.js.map +1 -1
  5. package/dist/cores/aws/aws-sns-service.js +3 -3
  6. package/dist/cores/aws/aws-sns-service.js.map +1 -1
  7. package/dist/cores/core-types.d.ts +92 -2
  8. package/dist/cores/core-types.js +1 -0
  9. package/dist/cores/core-types.js.map +1 -1
  10. package/dist/cores/dynamo-service.js +2 -2
  11. package/dist/cores/dynamo-service.js.map +1 -1
  12. package/dist/cores/elastic6-query-service.d.ts +42 -9
  13. package/dist/cores/elastic6-query-service.js +144 -134
  14. package/dist/cores/elastic6-query-service.js.map +1 -1
  15. package/dist/cores/elastic6-service.d.ts +144 -57
  16. package/dist/cores/elastic6-service.js +506 -322
  17. package/dist/cores/elastic6-service.js.map +1 -1
  18. package/dist/cores/lambda/lambda-cognito-handler.js.map +1 -1
  19. package/dist/cores/lambda/lambda-cron-handler.js.map +1 -1
  20. package/dist/cores/lambda/lambda-dynamo-stream-handler.js +3 -3
  21. package/dist/cores/lambda/lambda-dynamo-stream-handler.js.map +1 -1
  22. package/dist/cores/lambda/lambda-notification-handler.js.map +1 -1
  23. package/dist/cores/lambda/lambda-sns-handler.js.map +1 -1
  24. package/dist/cores/lambda/lambda-web-handler.js +2 -4
  25. package/dist/cores/lambda/lambda-web-handler.js.map +1 -1
  26. package/dist/cores/lambda/lambda-wss-handler.js.map +1 -1
  27. package/dist/cores/protocol/protocol-service.d.ts +1 -2
  28. package/dist/cores/protocol/protocol-service.js +5 -3
  29. package/dist/cores/protocol/protocol-service.js.map +1 -1
  30. package/dist/engine/builder.d.ts +1 -0
  31. package/dist/engine/builder.js +1 -1
  32. package/dist/engine/builder.js.map +1 -1
  33. package/dist/engine/engine.js +2 -1
  34. package/dist/engine/engine.js.map +1 -1
  35. package/dist/engine/index.d.ts +0 -1
  36. package/dist/engine/index.js +2 -4
  37. package/dist/engine/index.js.map +1 -1
  38. package/dist/engine/types.d.ts +0 -4
  39. package/dist/engine/types.js.map +1 -1
  40. package/dist/engine/utilities.d.ts +5 -1
  41. package/dist/engine/utilities.js +126 -11
  42. package/dist/engine/utilities.js.map +1 -1
  43. package/dist/tools/express.js +0 -3
  44. package/dist/tools/express.js.map +1 -1
  45. package/package.json +6 -11
  46. package/CHANGELOG.md +0 -61
  47. package/dist/docs/assets/css/main.css +0 -2321
  48. package/dist/docs/assets/images/icons.png +0 -0
  49. package/dist/docs/assets/images/icons@2x.png +0 -0
  50. package/dist/docs/assets/images/widgets.png +0 -0
  51. package/dist/docs/assets/images/widgets@2x.png +0 -0
  52. package/dist/docs/assets/js/main.js +0 -1
  53. package/dist/docs/assets/js/search.js +0 -3
  54. package/dist/docs/classes/abstractmanager.html +0 -1054
  55. package/dist/docs/classes/apiproxyclient.html +0 -509
  56. package/dist/docs/classes/apiservice.html +0 -805
  57. package/dist/docs/classes/awskmsservice.html +0 -468
  58. package/dist/docs/classes/awsmodule.html +0 -353
  59. package/dist/docs/classes/awss3service.html +0 -563
  60. package/dist/docs/classes/awssnsservice.html +0 -543
  61. package/dist/docs/classes/awssqsservice.html +0 -517
  62. package/dist/docs/classes/cacheservice.html +0 -996
  63. package/dist/docs/classes/configmodule.html +0 -311
  64. package/dist/docs/classes/dummycacheservice.html +0 -1000
  65. package/dist/docs/classes/dummycontroller.html +0 -709
  66. package/dist/docs/classes/dummydynamoservice.html +0 -915
  67. package/dist/docs/classes/dummyelastic6service.html +0 -791
  68. package/dist/docs/classes/dummyredisstorageservice.html +0 -804
  69. package/dist/docs/classes/dummystoragemaker.html +0 -383
  70. package/dist/docs/classes/dummystorageservice.html +0 -592
  71. package/dist/docs/classes/dynamoqueryservice.html +0 -413
  72. package/dist/docs/classes/dynamoscanservice.html +0 -358
  73. package/dist/docs/classes/dynamoservice.html +0 -844
  74. package/dist/docs/classes/dynamostorageservice.html +0 -623
  75. package/dist/docs/classes/elastic6queryservice.html +0 -458
  76. package/dist/docs/classes/elastic6service.html +0 -804
  77. package/dist/docs/classes/generalapicontroller.html +0 -877
  78. package/dist/docs/classes/generalcontroller.html +0 -454
  79. package/dist/docs/classes/generalcontrollerlocal.html +0 -499
  80. package/dist/docs/classes/generalcontrollerlocal2.html +0 -523
  81. package/dist/docs/classes/generalkeymaker.html +0 -335
  82. package/dist/docs/classes/generalmodelfilter.html +0 -529
  83. package/dist/docs/classes/generalwebcontroller.html +0 -580
  84. package/dist/docs/classes/hangulservice.html +0 -636
  85. package/dist/docs/classes/httpstorageservice.html +0 -539
  86. package/dist/docs/classes/lambdacognitohandler.html +0 -355
  87. package/dist/docs/classes/lambdacronhandler.html +0 -390
  88. package/dist/docs/classes/lambdacronhandlerlocal.html +0 -371
  89. package/dist/docs/classes/lambdadynamostreamhandler.html +0 -472
  90. package/dist/docs/classes/lambdadynamostreamhandlerlocal.html +0 -455
  91. package/dist/docs/classes/lambdahandler.html +0 -479
  92. package/dist/docs/classes/lambdahandlerlocal.html +0 -472
  93. package/dist/docs/classes/lambdamodule.html +0 -433
  94. package/dist/docs/classes/lambdanotificationhandler.html +0 -474
  95. package/dist/docs/classes/lambdanotificationhandlerlocal.html +0 -457
  96. package/dist/docs/classes/lambdasnshandler.html +0 -394
  97. package/dist/docs/classes/lambdasnshandlerlocal.html +0 -397
  98. package/dist/docs/classes/lambdasqshandler.html +0 -394
  99. package/dist/docs/classes/lambdasqshandlerlocal.html +0 -397
  100. package/dist/docs/classes/lambdasubhandler.html +0 -305
  101. package/dist/docs/classes/lambdawebhandler.html +0 -603
  102. package/dist/docs/classes/lambdawebhandlerlocal.html +0 -581
  103. package/dist/docs/classes/lambdawsshandler.html +0 -359
  104. package/dist/docs/classes/memcachedbackend.html +0 -900
  105. package/dist/docs/classes/mocksapiservice.html +0 -691
  106. package/dist/docs/classes/modelutil.html +0 -311
  107. package/dist/docs/classes/myconfigservice.html +0 -561
  108. package/dist/docs/classes/myconfigservicetest.html +0 -527
  109. package/dist/docs/classes/myconfigservicetest2.html +0 -522
  110. package/dist/docs/classes/mydummysqsservice.html +0 -419
  111. package/dist/docs/classes/myenginemodules.html +0 -357
  112. package/dist/docs/classes/mygeneralapicontroller.html +0 -837
  113. package/dist/docs/classes/mylemonwebcontroller.html +0 -356
  114. package/dist/docs/classes/mymodelfilter.html +0 -479
  115. package/dist/docs/classes/myprotocolservice.html +0 -993
  116. package/dist/docs/classes/myprotocolservicetest.html +0 -983
  117. package/dist/docs/classes/myservice.html +0 -329
  118. package/dist/docs/classes/mystorage.html +0 -1370
  119. package/dist/docs/classes/nodecachebackend.html +0 -714
  120. package/dist/docs/classes/protocolmodule.html +0 -311
  121. package/dist/docs/classes/proxystorageservice.html +0 -1441
  122. package/dist/docs/classes/query.html +0 -850
  123. package/dist/docs/classes/redisbackend.html +0 -781
  124. package/dist/docs/classes/redisstorageservice.html +0 -867
  125. package/dist/docs/classes/s3putobjectrequestbuilder.html +0 -509
  126. package/dist/docs/classes/scan.html +0 -685
  127. package/dist/docs/classes/snsprotocoltransformer.html +0 -334
  128. package/dist/docs/classes/sqsprotocoltransformer.html +0 -334
  129. package/dist/docs/classes/typedstorageservice.html +0 -914
  130. package/dist/docs/classes/uniquefieldmanager.html +0 -477
  131. package/dist/docs/classes/usermanager.html +0 -931
  132. package/dist/docs/classes/utilities.html +0 -1914
  133. package/dist/docs/classes/webprotocoltransformer.html +0 -330
  134. package/dist/docs/globals.html +0 -7477
  135. package/dist/docs/index.html +0 -1519
  136. package/dist/docs/interfaces/accountitem.html +0 -277
  137. package/dist/docs/interfaces/accountmodel.html +0 -306
  138. package/dist/docs/interfaces/adaptiveparam.html +0 -203
  139. package/dist/docs/interfaces/apiheaders.html +0 -183
  140. package/dist/docs/interfaces/apihttpproxy.html +0 -304
  141. package/dist/docs/interfaces/apiserviceclient.html +0 -448
  142. package/dist/docs/interfaces/autocompletesearchparam.html +0 -309
  143. package/dist/docs/interfaces/betweencondition.html +0 -226
  144. package/dist/docs/interfaces/cachebackend.html +0 -714
  145. package/dist/docs/interfaces/cacheentry.html +0 -248
  146. package/dist/docs/interfaces/cacheoptions.html +0 -267
  147. package/dist/docs/interfaces/callbackdata.html +0 -279
  148. package/dist/docs/interfaces/callbackparam.html +0 -252
  149. package/dist/docs/interfaces/comparisoncondition.html +0 -226
  150. package/dist/docs/interfaces/coreconfigservice.html +0 -342
  151. package/dist/docs/interfaces/corekey.html +0 -278
  152. package/dist/docs/interfaces/corekeymakeable.html +0 -292
  153. package/dist/docs/interfaces/corekmsservice.html +0 -311
  154. package/dist/docs/interfaces/coremodel.html +0 -499
  155. package/dist/docs/interfaces/coremodelfilterable.html +0 -281
  156. package/dist/docs/interfaces/cores3service.html +0 -444
  157. package/dist/docs/interfaces/coreservices.html +0 -232
  158. package/dist/docs/interfaces/coresnsservice.html +0 -317
  159. package/dist/docs/interfaces/corewebcontroller.html +0 -271
  160. package/dist/docs/interfaces/cronevent.html +0 -223
  161. package/dist/docs/interfaces/cronparam.html +0 -212
  162. package/dist/docs/interfaces/dynamooption.html +0 -254
  163. package/dist/docs/interfaces/dynamoqueryresult.html +0 -244
  164. package/dist/docs/interfaces/dynamoscanresult.html +0 -244
  165. package/dist/docs/interfaces/dynamosimplequeriable.html +0 -308
  166. package/dist/docs/interfaces/dynamosimplescannable.html +0 -255
  167. package/dist/docs/interfaces/dynamostreambody.html +0 -268
  168. package/dist/docs/interfaces/dynamostreamcallback.html +0 -209
  169. package/dist/docs/interfaces/dynamostreamfilter.html +0 -218
  170. package/dist/docs/interfaces/dynamostreamparam.html +0 -240
  171. package/dist/docs/interfaces/elastic6item.html +0 -221
  172. package/dist/docs/interfaces/elastic6option.html +0 -275
  173. package/dist/docs/interfaces/elastic6simplequeriable.html +0 -284
  174. package/dist/docs/interfaces/engineconsole.html +0 -292
  175. package/dist/docs/interfaces/enginecore.html +0 -344
  176. package/dist/docs/interfaces/enginemodule.html +0 -269
  177. package/dist/docs/interfaces/enginemodules.html +0 -316
  178. package/dist/docs/interfaces/engineoption.html +0 -244
  179. package/dist/docs/interfaces/enginescope.html +0 -220
  180. package/dist/docs/interfaces/existencecondition.html +0 -212
  181. package/dist/docs/interfaces/filter.html +0 -253
  182. package/dist/docs/interfaces/generalfuntion.html +0 -207
  183. package/dist/docs/interfaces/generalitem.html +0 -212
  184. package/dist/docs/interfaces/handlermap.html +0 -171
  185. package/dist/docs/interfaces/incrementable.html +0 -190
  186. package/dist/docs/interfaces/internalkey.html +0 -210
  187. package/dist/docs/interfaces/internalmodel.html +0 -226
  188. package/dist/docs/interfaces/itementry.html +0 -241
  189. package/dist/docs/interfaces/jwtcommon.html +0 -242
  190. package/dist/docs/interfaces/lambdahandlerservice.html +0 -340
  191. package/dist/docs/interfaces/lemonengine.html +0 -593
  192. package/dist/docs/interfaces/metricpostbody.html +0 -220
  193. package/dist/docs/interfaces/mygeneral.html +0 -271
  194. package/dist/docs/interfaces/mymodel.html +0 -554
  195. package/dist/docs/interfaces/myprotocolparam.html +0 -359
  196. package/dist/docs/interfaces/nextcontext.html +0 -381
  197. package/dist/docs/interfaces/nextidentity.html +0 -325
  198. package/dist/docs/interfaces/nextidentityaccess.html +0 -495
  199. package/dist/docs/interfaces/nextidentitycognito.html +0 -422
  200. package/dist/docs/interfaces/notificationbody.html +0 -171
  201. package/dist/docs/interfaces/notificationparam.html +0 -304
  202. package/dist/docs/interfaces/options.html +0 -226
  203. package/dist/docs/interfaces/parrallelcallback.html +0 -203
  204. package/dist/docs/interfaces/parrallelparam.html +0 -285
  205. package/dist/docs/interfaces/protocolbody.html +0 -183
  206. package/dist/docs/interfaces/protocolparam.html +0 -336
  207. package/dist/docs/interfaces/protocolservice.html +0 -548
  208. package/dist/docs/interfaces/protocoltransformer.html +0 -295
  209. package/dist/docs/interfaces/proxyparams.html +0 -212
  210. package/dist/docs/interfaces/putobjectresult.html +0 -282
  211. package/dist/docs/interfaces/queryresult.html +0 -272
  212. package/dist/docs/interfaces/redisoptions.html +0 -248
  213. package/dist/docs/interfaces/simplesearchparam.html +0 -351
  214. package/dist/docs/interfaces/slackaction.html +0 -240
  215. package/dist/docs/interfaces/slackattachment.html +0 -459
  216. package/dist/docs/interfaces/slackpostbody.html +0 -240
  217. package/dist/docs/interfaces/sqsattribute.html +0 -171
  218. package/dist/docs/interfaces/sqsmessage.html +0 -254
  219. package/dist/docs/interfaces/sqsrecord.html +0 -324
  220. package/dist/docs/interfaces/sqsservice.html +0 -333
  221. package/dist/docs/interfaces/sqsstatistics.html +0 -240
  222. package/dist/docs/interfaces/storagemakeable.html +0 -258
  223. package/dist/docs/interfaces/storagemodel.html +0 -285
  224. package/dist/docs/interfaces/storageservice.html +0 -497
  225. package/dist/docs/interfaces/stringcondition.html +0 -226
  226. package/dist/docs/interfaces/tagset.html +0 -171
  227. package/dist/docs/interfaces/testmodel.html +0 -334
  228. package/dist/docs/interfaces/timeout.html +0 -233
  229. package/dist/docs/interfaces/updatable.html +0 -193
  230. package/dist/docs/interfaces/user.html +0 -534
package/dist/docs/interfaces/cachebackend.html DELETED
@@ -1,714 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>CacheBackend | lemon-core - v2.2.20</title>
7
- <meta name="description" content="">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- </head>
11
- <body>
12
- <header>
13
- <div class="tsd-page-toolbar">
14
- <div class="container">
15
- <div class="table-wrap">
16
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
- <div class="field">
18
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
- <input id="tsd-search-field" type="text" />
20
- </div>
21
- <ul class="results">
22
- <li class="state loading">Preparing search index...</li>
23
- <li class="state failure">The search index is not available</li>
24
- </ul>
25
- <a href="../index.html" class="title">lemon-core - v2.2.20</a>
26
- </div>
27
- <div class="table-cell" id="tsd-widgets">
28
- <div id="tsd-filter">
29
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
- <div class="tsd-filter-group">
31
- <div class="tsd-select" id="tsd-filter-visibility">
32
- <span class="tsd-select-label">All</span>
33
- <ul class="tsd-select-list">
34
- <li data-value="public">Public</li>
35
- <li data-value="protected">Public/Protected</li>
36
- <li data-value="private" class="selected">All</li>
37
- </ul>
38
- </div>
39
- <input type="checkbox" id="tsd-filter-inherited" checked />
40
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
- <input type="checkbox" id="tsd-filter-externals" checked />
42
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
- <input type="checkbox" id="tsd-filter-only-exported" />
44
- <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
- </div>
46
- </div>
47
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
- </div>
49
- </div>
50
- </div>
51
- </div>
52
- <div class="tsd-page-title">
53
- <div class="container">
54
- <ul class="tsd-breadcrumb">
55
- <li>
56
- <a href="../globals.html">Globals</a>
57
- </li>
58
- <li>
59
- <a href="cachebackend.html">CacheBackend</a>
60
- </li>
61
- </ul>
62
- <h1>Interface CacheBackend</h1>
63
- </div>
64
- </div>
65
- </header>
66
- <div class="container container-main">
67
- <div class="row">
68
- <div class="col-8 col-content">
69
- <section class="tsd-panel tsd-comment">
70
- <div class="tsd-comment tsd-typography">
71
- <div class="lead">
72
- <p>interface <code>CacheBackend</code></p>
73
- </div>
74
- <dl class="tsd-comment-tags">
75
- <dt>internal</dt>
76
- <dd></dd>
77
- </dl>
78
- </div>
79
- </section>
80
- <section class="tsd-panel tsd-hierarchy">
81
- <h3>Hierarchy</h3>
82
- <ul class="tsd-hierarchy">
83
- <li>
84
- <span class="target">CacheBackend</span>
85
- </li>
86
- </ul>
87
- </section>
88
- <section class="tsd-panel">
89
- <h3>Implemented by</h3>
90
- <ul class="tsd-hierarchy">
91
- <li><a href="../classes/memcachedbackend.html" class="tsd-signature-type">MemcachedBackend</a></li>
92
- <li><a href="../classes/nodecachebackend.html" class="tsd-signature-type">NodeCacheBackend</a></li>
93
- <li><a href="../classes/redisbackend.html" class="tsd-signature-type">RedisBackend</a></li>
94
- </ul>
95
- </section>
96
- <section class="tsd-panel-group tsd-index-group">
97
- <h2>Index</h2>
98
- <section class="tsd-panel tsd-index-panel">
99
- <div class="tsd-index-content">
100
- <section class="tsd-index-section tsd-is-not-exported">
101
- <h3>Properties</h3>
102
- <ul class="tsd-index-list">
103
- <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="cachebackend.html#name" class="tsd-kind-icon">name</a></li>
104
- </ul>
105
- </section>
106
- <section class="tsd-index-section tsd-is-not-exported">
107
- <h3>Methods</h3>
108
- <ul class="tsd-index-list">
109
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="cachebackend.html#close" class="tsd-kind-icon">close</a></li>
110
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="cachebackend.html#del" class="tsd-kind-icon">del</a></li>
111
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="cachebackend.html#expire" class="tsd-kind-icon">expire</a></li>
112
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported"><a href="cachebackend.html#get" class="tsd-kind-icon">get</a></li>
113
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported"><a href="cachebackend.html#getset" class="tsd-kind-icon">getset</a></li>
114
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="cachebackend.html#has" class="tsd-kind-icon">has</a></li>
115
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="cachebackend.html#incr" class="tsd-kind-icon">incr</a></li>
116
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="cachebackend.html#keys" class="tsd-kind-icon">keys</a></li>
117
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported"><a href="cachebackend.html#mget" class="tsd-kind-icon">mget</a></li>
118
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported"><a href="cachebackend.html#mset" class="tsd-kind-icon">mset</a></li>
119
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported"><a href="cachebackend.html#pop" class="tsd-kind-icon">pop</a></li>
120
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported"><a href="cachebackend.html#set" class="tsd-kind-icon">set</a></li>
121
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="cachebackend.html#ttl" class="tsd-kind-icon">ttl</a></li>
122
- </ul>
123
- </section>
124
- </div>
125
- </section>
126
- </section>
127
- <section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
128
- <h2>Properties</h2>
129
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
130
- <a name="name" class="tsd-anchor"></a>
131
- <h3>name</h3>
132
- <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
133
- <aside class="tsd-sources">
134
- <ul>
135
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L549">src/cores/cache-service.ts:549</a></li>
136
- </ul>
137
- </aside>
138
- <div class="tsd-comment tsd-typography">
139
- <div class="lead">
140
- <p>backend type</p>
141
- </div>
142
- </div>
143
- </section>
144
- </section>
145
- <section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
146
- <h2>Methods</h2>
147
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
148
- <a name="close" class="tsd-anchor"></a>
149
- <h3>close</h3>
150
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
151
- <li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span><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">void</span><span class="tsd-signature-symbol">&gt;</span></li>
152
- </ul>
153
- <ul class="tsd-descriptions">
154
- <li class="tsd-description">
155
- <aside class="tsd-sources">
156
- <ul>
157
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L656">src/cores/cache-service.ts:656</a></li>
158
- </ul>
159
- </aside>
160
- <div class="tsd-comment tsd-typography">
161
- <div class="lead">
162
- <p>Close connection(s) to the cache server</p>
163
- </div>
164
- </div>
165
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
166
- </li>
167
- </ul>
168
- </section>
169
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
170
- <a name="del" class="tsd-anchor"></a>
171
- <h3>del</h3>
172
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
173
- <li class="tsd-signature tsd-kind-icon">del<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
174
- </ul>
175
- <ul class="tsd-descriptions">
176
- <li class="tsd-description">
177
- <aside class="tsd-sources">
178
- <ul>
179
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L632">src/cores/cache-service.ts:632</a></li>
180
- </ul>
181
- </aside>
182
- <div class="tsd-comment tsd-typography">
183
- <div class="lead">
184
- <p>Delete a key</p>
185
- </div>
186
- </div>
187
- <h4 class="tsd-parameters-title">Parameters</h4>
188
- <ul class="tsd-parameters">
189
- <li>
190
- <h5>key: <span class="tsd-signature-type">string</span></h5>
191
- </li>
192
- </ul>
193
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
194
- <p>true on success</p>
195
- </li>
196
- </ul>
197
- </section>
198
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
199
- <a name="expire" class="tsd-anchor"></a>
200
- <h3>expire</h3>
201
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
202
- <li class="tsd-signature tsd-kind-icon">expire<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ttl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
203
- </ul>
204
- <ul class="tsd-descriptions">
205
- <li class="tsd-description">
206
- <aside class="tsd-sources">
207
- <ul>
208
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L641">src/cores/cache-service.ts:641</a></li>
209
- </ul>
210
- </aside>
211
- <div class="tsd-comment tsd-typography">
212
- <div class="lead">
213
- <p>Set the time to live in seconds</p>
214
- </div>
215
- </div>
216
- <h4 class="tsd-parameters-title">Parameters</h4>
217
- <ul class="tsd-parameters">
218
- <li>
219
- <h5>key: <span class="tsd-signature-type">string</span></h5>
220
- </li>
221
- <li>
222
- <h5>ttl: <span class="tsd-signature-type">number</span></h5>
223
- <div class="tsd-comment tsd-typography">
224
- <p>time to live in seconds</p>
225
- </div>
226
- </li>
227
- </ul>
228
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
229
- <p>true on success</p>
230
- </li>
231
- </ul>
232
- </section>
233
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
234
- <a name="get" class="tsd-anchor"></a>
235
- <h3>get</h3>
236
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
237
- <li class="tsd-signature tsd-kind-icon">get&lt;T&gt;<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></li>
238
- </ul>
239
- <ul class="tsd-descriptions">
240
- <li class="tsd-description">
241
- <aside class="tsd-sources">
242
- <ul>
243
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L567">src/cores/cache-service.ts:567</a></li>
244
- </ul>
245
- </aside>
246
- <div class="tsd-comment tsd-typography">
247
- <div class="lead">
248
- <p>Get the value of a key</p>
249
- </div>
250
- </div>
251
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
252
- <ul class="tsd-type-parameters">
253
- <li>
254
- <h4>T</h4>
255
- </li>
256
- </ul>
257
- <h4 class="tsd-parameters-title">Parameters</h4>
258
- <ul class="tsd-parameters">
259
- <li>
260
- <h5>key: <span class="tsd-signature-type">string</span></h5>
261
- </li>
262
- </ul>
263
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4>
264
- <p>the value of key, or undefined when key does not exist</p>
265
- </li>
266
- </ul>
267
- </section>
268
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
269
- <a name="getset" class="tsd-anchor"></a>
270
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> getset</h3>
271
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
272
- <li class="tsd-signature tsd-kind-icon">getset&lt;T, U&gt;<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><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">U</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></li>
273
- </ul>
274
- <ul class="tsd-descriptions">
275
- <li class="tsd-description">
276
- <aside class="tsd-sources">
277
- <ul>
278
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L592">src/cores/cache-service.ts:592</a></li>
279
- </ul>
280
- </aside>
281
- <div class="tsd-comment tsd-typography">
282
- <div class="lead">
283
- <p>(optional) Set the value of a key and return its old value</p>
284
- </div>
285
- </div>
286
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
287
- <ul class="tsd-type-parameters">
288
- <li>
289
- <h4>T</h4>
290
- </li>
291
- <li>
292
- <h4>U</h4>
293
- </li>
294
- </ul>
295
- <h4 class="tsd-parameters-title">Parameters</h4>
296
- <ul class="tsd-parameters">
297
- <li>
298
- <h5>key: <span class="tsd-signature-type">string</span></h5>
299
- </li>
300
- <li>
301
- <h5>val: <span class="tsd-signature-type">T</span></h5>
302
- </li>
303
- </ul>
304
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">U</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4>
305
- <p>the old value stored at key, or undefined when key did not exist</p>
306
- </li>
307
- </ul>
308
- </section>
309
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
310
- <a name="has" class="tsd-anchor"></a>
311
- <h3>has</h3>
312
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
313
- <li class="tsd-signature tsd-kind-icon">has<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
314
- </ul>
315
- <ul class="tsd-descriptions">
316
- <li class="tsd-description">
317
- <aside class="tsd-sources">
318
- <ul>
319
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L624">src/cores/cache-service.ts:624</a></li>
320
- </ul>
321
- </aside>
322
- <div class="tsd-comment tsd-typography">
323
- <div class="lead">
324
- <p>Determine if a key exists</p>
325
- </div>
326
- </div>
327
- <h4 class="tsd-parameters-title">Parameters</h4>
328
- <ul class="tsd-parameters">
329
- <li>
330
- <h5>key: <span class="tsd-signature-type">string</span></h5>
331
- </li>
332
- </ul>
333
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
334
- <p>true on success</p>
335
- </li>
336
- </ul>
337
- </section>
338
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
339
- <a name="incr" class="tsd-anchor"></a>
340
- <h3>incr</h3>
341
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
342
- <li class="tsd-signature tsd-kind-icon">incr<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, increment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><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">number</span><span class="tsd-signature-symbol">&gt;</span></li>
343
- </ul>
344
- <ul class="tsd-descriptions">
345
- <li class="tsd-description">
346
- <aside class="tsd-sources">
347
- <ul>
348
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L609">src/cores/cache-service.ts:609</a></li>
349
- </ul>
350
- </aside>
351
- <div class="tsd-comment tsd-typography">
352
- <div class="lead">
353
- <p>Increment the integer value of a key</p>
354
- </div>
355
- </div>
356
- <h4 class="tsd-parameters-title">Parameters</h4>
357
- <ul class="tsd-parameters">
358
- <li>
359
- <h5>key: <span class="tsd-signature-type">string</span></h5>
360
- </li>
361
- <li>
362
- <h5>increment: <span class="tsd-signature-type">number</span></h5>
363
- <div class="tsd-comment tsd-typography">
364
- <p>amount to increment</p>
365
- </div>
366
- </li>
367
- </ul>
368
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
369
- <p>the value of key after the increment</p>
370
- </li>
371
- </ul>
372
- </section>
373
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
374
- <a name="keys" class="tsd-anchor"></a>
375
- <h3>keys</h3>
376
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
377
- <li class="tsd-signature tsd-kind-icon">keys<span class="tsd-signature-symbol">(</span><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">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
378
- </ul>
379
- <ul class="tsd-descriptions">
380
- <li class="tsd-description">
381
- <aside class="tsd-sources">
382
- <ul>
383
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L616">src/cores/cache-service.ts:616</a></li>
384
- </ul>
385
- </aside>
386
- <div class="tsd-comment tsd-typography">
387
- <div class="lead">
388
- <p>List all keys</p>
389
- </div>
390
- </div>
391
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
392
- <p>list of keys</p>
393
- </li>
394
- </ul>
395
- </section>
396
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
397
- <a name="mget" class="tsd-anchor"></a>
398
- <h3>mget</h3>
399
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
400
- <li class="tsd-signature tsd-kind-icon">mget&lt;T&gt;<span class="tsd-signature-symbol">(</span>keys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><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">object</span><span class="tsd-signature-symbol">&gt;</span></li>
401
- </ul>
402
- <ul class="tsd-descriptions">
403
- <li class="tsd-description">
404
- <aside class="tsd-sources">
405
- <ul>
406
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L583">src/cores/cache-service.ts:583</a></li>
407
- </ul>
408
- </aside>
409
- <div class="tsd-comment tsd-typography">
410
- <div class="lead">
411
- <p>Get the values of all the given keys</p>
412
- </div>
413
- </div>
414
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
415
- <ul class="tsd-type-parameters">
416
- <li>
417
- <h4>T</h4>
418
- </li>
419
- </ul>
420
- <h4 class="tsd-parameters-title">Parameters</h4>
421
- <ul class="tsd-parameters">
422
- <li>
423
- <h5>keys: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
424
- </li>
425
- </ul>
426
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
427
- <p>key-value map</p>
428
- </li>
429
- </ul>
430
- </section>
431
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
432
- <a name="mset" class="tsd-anchor"></a>
433
- <h3>mset</h3>
434
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
435
- <li class="tsd-signature tsd-kind-icon">mset&lt;T&gt;<span class="tsd-signature-symbol">(</span>entries<span class="tsd-signature-symbol">: </span><a href="itementry.html" class="tsd-signature-type">ItemEntry</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
436
- </ul>
437
- <ul class="tsd-descriptions">
438
- <li class="tsd-description">
439
- <aside class="tsd-sources">
440
- <ul>
441
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L575">src/cores/cache-service.ts:575</a></li>
442
- </ul>
443
- </aside>
444
- <div class="tsd-comment tsd-typography">
445
- <div class="lead">
446
- <p>Set multiple keys to multiple values</p>
447
- </div>
448
- </div>
449
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
450
- <ul class="tsd-type-parameters">
451
- <li>
452
- <h4>T</h4>
453
- </li>
454
- </ul>
455
- <h4 class="tsd-parameters-title">Parameters</h4>
456
- <ul class="tsd-parameters">
457
- <li>
458
- <h5>entries: <a href="itementry.html" class="tsd-signature-type">ItemEntry</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5>
459
- <div class="tsd-comment tsd-typography">
460
- <p>see ItemEntry</p>
461
- </div>
462
- </li>
463
- </ul>
464
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
465
- <p>true on success</p>
466
- </li>
467
- </ul>
468
- </section>
469
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
470
- <a name="pop" class="tsd-anchor"></a>
471
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> pop</h3>
472
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
473
- <li class="tsd-signature tsd-kind-icon">pop&lt;T&gt;<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></li>
474
- </ul>
475
- <ul class="tsd-descriptions">
476
- <li class="tsd-description">
477
- <aside class="tsd-sources">
478
- <ul>
479
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L600">src/cores/cache-service.ts:600</a></li>
480
- </ul>
481
- </aside>
482
- <div class="tsd-comment tsd-typography">
483
- <div class="lead">
484
- <p>(optional) Get the value of a key and remove the key</p>
485
- </div>
486
- </div>
487
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
488
- <ul class="tsd-type-parameters">
489
- <li>
490
- <h4>T</h4>
491
- </li>
492
- </ul>
493
- <h4 class="tsd-parameters-title">Parameters</h4>
494
- <ul class="tsd-parameters">
495
- <li>
496
- <h5>key: <span class="tsd-signature-type">string</span></h5>
497
- </li>
498
- </ul>
499
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4>
500
- <p>the old value stored at key, or undefined when key did not exist</p>
501
- </li>
502
- </ul>
503
- </section>
504
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
505
- <a name="set" class="tsd-anchor"></a>
506
- <h3>set</h3>
507
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
508
- <li class="tsd-signature tsd-kind-icon">set&lt;T&gt;<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, ttl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
509
- </ul>
510
- <ul class="tsd-descriptions">
511
- <li class="tsd-description">
512
- <aside class="tsd-sources">
513
- <ul>
514
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L559">src/cores/cache-service.ts:559</a></li>
515
- </ul>
516
- </aside>
517
- <div class="tsd-comment tsd-typography">
518
- <div class="lead">
519
- <p>Set the value of a key</p>
520
- </div>
521
- </div>
522
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
523
- <ul class="tsd-type-parameters">
524
- <li>
525
- <h4>T</h4>
526
- </li>
527
- </ul>
528
- <h4 class="tsd-parameters-title">Parameters</h4>
529
- <ul class="tsd-parameters">
530
- <li>
531
- <h5>key: <span class="tsd-signature-type">string</span></h5>
532
- </li>
533
- <li>
534
- <h5>val: <span class="tsd-signature-type">T</span></h5>
535
- </li>
536
- <li>
537
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> ttl: <span class="tsd-signature-type">number</span></h5>
538
- <div class="tsd-comment tsd-typography">
539
- <p>(optional) time to live in seconds</p>
540
- </div>
541
- </li>
542
- </ul>
543
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
544
- <p>true on success</p>
545
- </li>
546
- </ul>
547
- </section>
548
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
549
- <a name="ttl" class="tsd-anchor"></a>
550
- <h3>ttl</h3>
551
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
552
- <li class="tsd-signature tsd-kind-icon">ttl<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></li>
553
- </ul>
554
- <ul class="tsd-descriptions">
555
- <li class="tsd-description">
556
- <aside class="tsd-sources">
557
- <ul>
558
- <li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/cache-service.ts#L651">src/cores/cache-service.ts:651</a></li>
559
- </ul>
560
- </aside>
561
- <div class="tsd-comment tsd-typography">
562
- <div class="lead">
563
- <p>Get the time to live for a key in milliseconds</p>
564
- </div>
565
- </div>
566
- <h4 class="tsd-parameters-title">Parameters</h4>
567
- <ul class="tsd-parameters">
568
- <li>
569
- <h5>key: <span class="tsd-signature-type">string</span></h5>
570
- </li>
571
- </ul>
572
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4>
573
- <p>the remaining time to live in milliseconds
574
- - 0 if the key exists but has no associated timeout
575
- - undefined if the key does not exist</p>
576
- </li>
577
- </ul>
578
- </section>
579
- </section>
580
- </div>
581
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
582
- <nav class="tsd-navigation primary">
583
- <ul>
584
- <li class="globals ">
585
- <a href="../globals.html"><em>Globals</em></a>
586
- </li>
587
- </ul>
588
- </nav>
589
- <nav class="tsd-navigation secondary menu-sticky">
590
- <ul class="before-current">
591
- </ul>
592
- <ul class="current">
593
- <li class="current tsd-kind-interface tsd-is-not-exported">
594
- <a href="cachebackend.html" class="tsd-kind-icon">Cache<wbr>Backend</a>
595
- <ul>
596
- <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
597
- <a href="cachebackend.html#name" class="tsd-kind-icon">name</a>
598
- </li>
599
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
600
- <a href="cachebackend.html#close" class="tsd-kind-icon">close</a>
601
- </li>
602
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
603
- <a href="cachebackend.html#del" class="tsd-kind-icon">del</a>
604
- </li>
605
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
606
- <a href="cachebackend.html#expire" class="tsd-kind-icon">expire</a>
607
- </li>
608
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
609
- <a href="cachebackend.html#get" class="tsd-kind-icon">get</a>
610
- </li>
611
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
612
- <a href="cachebackend.html#getset" class="tsd-kind-icon">getset</a>
613
- </li>
614
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
615
- <a href="cachebackend.html#has" class="tsd-kind-icon">has</a>
616
- </li>
617
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
618
- <a href="cachebackend.html#incr" class="tsd-kind-icon">incr</a>
619
- </li>
620
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
621
- <a href="cachebackend.html#keys" class="tsd-kind-icon">keys</a>
622
- </li>
623
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
624
- <a href="cachebackend.html#mget" class="tsd-kind-icon">mget</a>
625
- </li>
626
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
627
- <a href="cachebackend.html#mset" class="tsd-kind-icon">mset</a>
628
- </li>
629
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
630
- <a href="cachebackend.html#pop" class="tsd-kind-icon">pop</a>
631
- </li>
632
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-not-exported">
633
- <a href="cachebackend.html#set" class="tsd-kind-icon">set</a>
634
- </li>
635
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
636
- <a href="cachebackend.html#ttl" class="tsd-kind-icon">ttl</a>
637
- </li>
638
- </ul>
639
- </li>
640
- </ul>
641
- <ul class="after-current">
642
- </ul>
643
- </nav>
644
- </div>
645
- </div>
646
- </div>
647
- <footer class="with-border-bottom">
648
- <div class="container">
649
- <h2>Legend</h2>
650
- <div class="tsd-legend-group">
651
- <ul class="tsd-legend">
652
- <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
653
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
654
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
655
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
656
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
657
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
658
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
659
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
660
- </ul>
661
- <ul class="tsd-legend">
662
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
663
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
664
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
665
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
666
- </ul>
667
- <ul class="tsd-legend">
668
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
669
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
670
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
671
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
672
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
673
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
674
- </ul>
675
- <ul class="tsd-legend">
676
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
677
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
678
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
679
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
680
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
681
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
682
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
683
- </ul>
684
- <ul class="tsd-legend">
685
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
686
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
687
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
688
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
689
- </ul>
690
- <ul class="tsd-legend">
691
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
692
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
693
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
694
- </ul>
695
- <ul class="tsd-legend">
696
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
697
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
698
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
699
- </ul>
700
- <ul class="tsd-legend">
701
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
702
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
703
- </ul>
704
- </div>
705
- </div>
706
- </footer>
707
- <div class="container tsd-generator">
708
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
709
- </div>
710
- <div class="overlay"></div>
711
- <script src="../assets/js/main.js"></script>
712
- <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
713
- </body>
714
- </html>