1- @soluble/cache-interop - v0.9.1
1+ @soluble/cache-interop
22
3- # @soluble/cache-interop - v0.9.1
3+ # @soluble/cache-interop - v0.12.5
44
55## Table of contents
66
3333- [ EvictionPolicyInterface] ( interfaces/EvictionPolicyInterface.md )
3434- [ SerializerInterface] ( interfaces/SerializerInterface.md )
3535
36- ### Type aliases
36+ ### Type Aliases
3737
3838- [ CacheExpiresAt] ( README.md#cacheexpiresat )
3939- [ CacheItemMetadata] ( README.md#cacheitemmetadata )
5151
5252- [ executeValueProviderFn] ( README.md#executevalueproviderfn )
5353
54- ## Type aliases
54+ ## Type Aliases
5555
5656### CacheExpiresAt
5757
5858Ƭ ** CacheExpiresAt** : ` number `
5959
60- ___
60+ ---
6161
6262### CacheItemMetadata
6363
6464Ƭ ** CacheItemMetadata** <` K ` \> : ` Object `
6565
6666#### Type parameters
6767
68- | Name | Type |
69- | :------ | :------ |
70- | ` K ` | extends [ ` CacheKey ` ] ( README.md#cachekey ) = [ ` CacheKey ` ] ( README.md#cachekey ) |
68+ | Name | Type |
69+ | :--- | :-------------------------------------------------------------------- ------ |
70+ | ` K ` | extends [ ` CacheKey ` ] ( README.md#cachekey ) = [ ` CacheKey ` ] ( README.md#cachekey ) |
7171
7272#### Type declaration
7373
74- | Name | Type |
75- | :------ | :--- --- |
76- | ` key ` | ` K ` |
74+ | Name | Type |
75+ | :---- | :--- |
76+ | ` key ` | ` K ` |
7777
78- ___
78+ ---
7979
8080### CacheKey
8181
8282Ƭ ** CacheKey** : ` string `
8383
84- ___
84+ ---
8585
8686### CacheProviderAsyncFn
8787
9090#### Type parameters
9191
9292| Name |
93- | :------ |
94- | ` T ` |
93+ | :--- |
94+ | ` T ` |
9595
9696#### Type declaration
9797
9898▸ (` params? ` ): ` Promise ` <` T ` \>
9999
100100##### Parameters
101101
102- | Name | Type |
103- | :------ | :------ |
102+ | Name | Type |
103+ | :-------- | :------------------- ------ |
104104| ` params? ` | ` CacheValueProviderParams ` |
105105
106106##### Returns
107107
108108` Promise ` <` T ` \>
109109
110- ___
110+ ---
111111
112112### CacheProviderSyncFn
113113
@@ -116,24 +116,24 @@ ___
116116#### Type parameters
117117
118118| Name |
119- | :------ |
120- | ` T ` |
119+ | :--- |
120+ | ` T ` |
121121
122122#### Type declaration
123123
124124▸ (` params? ` ): ` T `
125125
126126##### Parameters
127127
128- | Name | Type |
129- | :------ | :------ |
128+ | Name | Type |
129+ | :-------- | :------------------- ------ |
130130| ` params? ` | ` CacheValueProviderParams ` |
131131
132132##### Returns
133133
134134` T `
135135
136- ___
136+ ---
137137
138138### CacheValueProviderFn
139139
@@ -142,22 +142,22 @@ ___
142142#### Type parameters
143143
144144| Name |
145- | :------ |
146- | ` T ` |
145+ | :--- |
146+ | ` T ` |
147147
148- ___
148+ ---
149149
150150### DeleteOptions
151151
152152Ƭ ** DeleteOptions** : ` Object `
153153
154154#### Type declaration
155155
156- | Name | Type | Description |
157- | :------ | :------ | :------ |
156+ | Name | Type | Description |
157+ | :-------------- | :-------- | :------------------------------------- ------ |
158158| ` disableCache? ` | ` boolean ` | Whether to disable caching, by default false |
159159
160- ___
160+ ---
161161
162162### GetOptions
163163
@@ -166,47 +166,47 @@ ___
166166#### Type parameters
167167
168168| Name |
169- | :------ |
170- | ` T ` |
169+ | :--- |
170+ | ` T ` |
171171
172172#### Type declaration
173173
174- | Name | Type |
175- | :------ | :------ |
176- | ` defaultValue? ` | ` T ` |
174+ | Name | Type |
175+ | :-------------- | :-- ------ |
176+ | ` defaultValue? ` | ` T ` |
177177| ` disableCache? ` | ` boolean ` |
178178
179- ___
179+ ---
180180
181181### GetOrSetOptions
182182
183- Ƭ ** GetOrSetOptions** : ` Omit ` <[ ` SetOptions ` ] ( README.md#setoptions ) , `` "disableCache" `` \> & { ` disableCache? ` : ` boolean ` \| { ` read ` : ` boolean ` ; ` write ` : ` boolean ` } ; ` onError? ` : (` errors ` : [ ` CacheException ` ] ( classes/CacheException.md ) [ ] ) => ` void ` }
183+ Ƭ ** GetOrSetOptions** : ` Omit ` <[ ` SetOptions ` ] ( README.md#setoptions ) , ` "disableCache" ` \> & { ` disableCache? ` : ` boolean ` \| { ` read ` : ` boolean ` ; ` write ` : ` boolean ` } ; ` onError? ` : (` errors ` : [ ` CacheException ` ] ( classes/CacheException.md ) [ ] ) => ` void ` }
184184
185- ___
185+ ---
186186
187187### HasOptions
188188
189189Ƭ ** HasOptions** : ` Object `
190190
191191#### Type declaration
192192
193- | Name | Type | Description |
194- | :------ | :------ | :------ |
195- | ` disableCache? ` | ` boolean ` | Whether to disable caching, by default false |
196- | ` onError? ` | (` error ` : [ ` CacheException ` ] ( classes/CacheException.md ) ) => ` void ` | Callback since Cache.has can't really return CacheException... |
193+ | Name | Type | Description |
194+ | :-------------- | :----------------------------------------------------------------- | :------------------------------------------------------- ------ |
195+ | ` disableCache? ` | ` boolean ` | Whether to disable caching, by default false |
196+ | ` onError? ` | (` error ` : [ ` CacheException ` ] ( classes/CacheException.md ) ) => ` void ` | Callback since Cache.has can't really return CacheException... |
197197
198- ___
198+ ---
199199
200200### SetOptions
201201
202202Ƭ ** SetOptions** : ` Object `
203203
204204#### Type declaration
205205
206- | Name | Type | Description |
207- | :------ | :------ | :------ |
208- | ` disableCache? ` | ` boolean ` | Whether to disable caching, by default false |
209- | ` ttl? ` | ` number ` | Time-To-Live expressed in seconds, 0 meaning forever |
206+ | Name | Type | Description |
207+ | :-------------- | :-------- | :--------------------------------------------- ------ |
208+ | ` disableCache? ` | ` boolean ` | Whether to disable caching, by default false |
209+ | ` ttl? ` | ` number ` | Time-To-Live expressed in seconds, 0 meaning forever |
210210
211211## Functions
212212
@@ -217,13 +217,13 @@ ___
217217#### Type parameters
218218
219219| Name |
220- | :------ |
221- | ` T ` |
220+ | :--- |
221+ | ` T ` |
222222
223223#### Parameters
224224
225- | Name | Type |
226- | :------ | :------ |
225+ | Name | Type |
226+ | :-------------- | :--------------------------------------------- ------ |
227227| ` syncOrAsyncFn ` | ` AsyncFn ` <` T ` \> \| ` SyncFn ` <` T ` \> \| ` Promise ` <` T ` \> |
228228
229229#### Returns
0 commit comments