1
- @soluble/cache-interop - v0.9.1
1
+ @soluble/cache-interop
2
2
3
- # @soluble/cache-interop - v0.9.1
3
+ # @soluble/cache-interop - v0.12.5
4
4
5
5
## Table of contents
6
6
33
33
- [ EvictionPolicyInterface] ( interfaces/EvictionPolicyInterface.md )
34
34
- [ SerializerInterface] ( interfaces/SerializerInterface.md )
35
35
36
- ### Type aliases
36
+ ### Type Aliases
37
37
38
38
- [ CacheExpiresAt] ( README.md#cacheexpiresat )
39
39
- [ CacheItemMetadata] ( README.md#cacheitemmetadata )
51
51
52
52
- [ executeValueProviderFn] ( README.md#executevalueproviderfn )
53
53
54
- ## Type aliases
54
+ ## Type Aliases
55
55
56
56
### CacheExpiresAt
57
57
58
58
Ƭ ** CacheExpiresAt** : ` number `
59
59
60
- ___
60
+ ---
61
61
62
62
### CacheItemMetadata
63
63
64
64
Ƭ ** CacheItemMetadata** <` K ` \> : ` Object `
65
65
66
66
#### Type parameters
67
67
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 ) |
71
71
72
72
#### Type declaration
73
73
74
- | Name | Type |
75
- | :------ | :--- --- |
76
- | ` key ` | ` K ` |
74
+ | Name | Type |
75
+ | :---- | :--- |
76
+ | ` key ` | ` K ` |
77
77
78
- ___
78
+ ---
79
79
80
80
### CacheKey
81
81
82
82
Ƭ ** CacheKey** : ` string `
83
83
84
- ___
84
+ ---
85
85
86
86
### CacheProviderAsyncFn
87
87
90
90
#### Type parameters
91
91
92
92
| Name |
93
- | :------ |
94
- | ` T ` |
93
+ | :--- |
94
+ | ` T ` |
95
95
96
96
#### Type declaration
97
97
98
98
▸ (` params? ` ): ` Promise ` <` T ` \>
99
99
100
100
##### Parameters
101
101
102
- | Name | Type |
103
- | :------ | :------ |
102
+ | Name | Type |
103
+ | :-------- | :------------------- ------ |
104
104
| ` params? ` | ` CacheValueProviderParams ` |
105
105
106
106
##### Returns
107
107
108
108
` Promise ` <` T ` \>
109
109
110
- ___
110
+ ---
111
111
112
112
### CacheProviderSyncFn
113
113
@@ -116,24 +116,24 @@ ___
116
116
#### Type parameters
117
117
118
118
| Name |
119
- | :------ |
120
- | ` T ` |
119
+ | :--- |
120
+ | ` T ` |
121
121
122
122
#### Type declaration
123
123
124
124
▸ (` params? ` ): ` T `
125
125
126
126
##### Parameters
127
127
128
- | Name | Type |
129
- | :------ | :------ |
128
+ | Name | Type |
129
+ | :-------- | :------------------- ------ |
130
130
| ` params? ` | ` CacheValueProviderParams ` |
131
131
132
132
##### Returns
133
133
134
134
` T `
135
135
136
- ___
136
+ ---
137
137
138
138
### CacheValueProviderFn
139
139
@@ -142,22 +142,22 @@ ___
142
142
#### Type parameters
143
143
144
144
| Name |
145
- | :------ |
146
- | ` T ` |
145
+ | :--- |
146
+ | ` T ` |
147
147
148
- ___
148
+ ---
149
149
150
150
### DeleteOptions
151
151
152
152
Ƭ ** DeleteOptions** : ` Object `
153
153
154
154
#### Type declaration
155
155
156
- | Name | Type | Description |
157
- | :------ | :------ | :------ |
156
+ | Name | Type | Description |
157
+ | :-------------- | :-------- | :------------------------------------- ------ |
158
158
| ` disableCache? ` | ` boolean ` | Whether to disable caching, by default false |
159
159
160
- ___
160
+ ---
161
161
162
162
### GetOptions
163
163
@@ -166,47 +166,47 @@ ___
166
166
#### Type parameters
167
167
168
168
| Name |
169
- | :------ |
170
- | ` T ` |
169
+ | :--- |
170
+ | ` T ` |
171
171
172
172
#### Type declaration
173
173
174
- | Name | Type |
175
- | :------ | :------ |
176
- | ` defaultValue? ` | ` T ` |
174
+ | Name | Type |
175
+ | :-------------- | :-- ------ |
176
+ | ` defaultValue? ` | ` T ` |
177
177
| ` disableCache? ` | ` boolean ` |
178
178
179
- ___
179
+ ---
180
180
181
181
### GetOrSetOptions
182
182
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 ` }
184
184
185
- ___
185
+ ---
186
186
187
187
### HasOptions
188
188
189
189
Ƭ ** HasOptions** : ` Object `
190
190
191
191
#### Type declaration
192
192
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... |
197
197
198
- ___
198
+ ---
199
199
200
200
### SetOptions
201
201
202
202
Ƭ ** SetOptions** : ` Object `
203
203
204
204
#### Type declaration
205
205
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 |
210
210
211
211
## Functions
212
212
@@ -217,13 +217,13 @@ ___
217
217
#### Type parameters
218
218
219
219
| Name |
220
- | :------ |
221
- | ` T ` |
220
+ | :--- |
221
+ | ` T ` |
222
222
223
223
#### Parameters
224
224
225
- | Name | Type |
226
- | :------ | :------ |
225
+ | Name | Type |
226
+ | :-------------- | :--------------------------------------------- ------ |
227
227
| ` syncOrAsyncFn ` | ` AsyncFn ` <` T ` \> \| ` SyncFn ` <` T ` \> \| ` Promise ` <` T ` \> |
228
228
229
229
#### Returns
0 commit comments