@valon-technologies/gestalt
Preparing search index...
index
CacheProviderOptions
Interface CacheProviderOptions
Runtime hooks required to implement a Gestalt cache provider.
interface
CacheProviderOptions
{
name
?:
string
;
displayName
?:
string
;
description
?:
string
;
version
?:
string
;
configure
?:
ConfigureHandler
;
healthCheck
?:
HealthCheckHandler
;
warnings
?:
string
[]
|
WarningsHandler
;
start
?:
StartHandler
;
close
?:
CloseHandler
;
get
:
(
key
:
string
,
)
=>
MaybePromise
<
Uint8Array
<
ArrayBufferLike
>
|
null
|
undefined
>
;
set
:
(
key
:
string
,
value
:
Uint8Array
,
options
?:
CacheSetOptions
,
)
=>
MaybePromise
<
void
>
;
delete
:
(
key
:
string
)
=>
MaybePromise
<
boolean
>
;
touch
:
(
key
:
string
,
ttlMs
:
number
)
=>
MaybePromise
<
boolean
>
;
getMany
?:
(
keys
:
string
[]
,
)
=>
MaybePromise
<
Record
<
string
,
Uint8Array
<
ArrayBufferLike
>
>
>
;
setMany
?:
(
entries
:
CacheEntry
[]
,
options
?:
CacheSetOptions
,
)
=>
MaybePromise
<
void
>
;
deleteMany
?:
(
keys
:
string
[]
)
=>
MaybePromise
<
number
|
bigint
>
;
}
Hierarchy (
View Summary
)
ProviderBaseOptions
CacheProviderOptions
Index
Properties
name?
display
Name?
description?
version?
configure?
health
Check?
warnings?
start?
close?
get
set
delete
touch
get
Many?
set
Many?
delete
Many?
Properties
Optional
name
name
?:
string
Optional
display
Name
displayName
?:
string
Optional
description
description
?:
string
Optional
version
version
?:
string
Optional
configure
configure
?:
ConfigureHandler
Optional
health
Check
healthCheck
?:
HealthCheckHandler
Optional
warnings
warnings
?:
string
[]
|
WarningsHandler
Optional
start
start
?:
StartHandler
Optional
close
close
?:
CloseHandler
get
get
:
(
key
:
string
,
)
=>
MaybePromise
<
Uint8Array
<
ArrayBufferLike
>
|
null
|
undefined
>
set
set
:
(
key
:
string
,
value
:
Uint8Array
,
options
?:
CacheSetOptions
,
)
=>
MaybePromise
<
void
>
delete
delete
:
(
key
:
string
)
=>
MaybePromise
<
boolean
>
touch
touch
:
(
key
:
string
,
ttlMs
:
number
)
=>
MaybePromise
<
boolean
>
Optional
get
Many
getMany
?:
(
keys
:
string
[]
,
)
=>
MaybePromise
<
Record
<
string
,
Uint8Array
<
ArrayBufferLike
>
>
>
Optional
set
Many
setMany
?:
(
entries
:
CacheEntry
[]
,
options
?:
CacheSetOptions
,
)
=>
MaybePromise
<
void
>
Optional
delete
Many
deleteMany
?:
(
keys
:
string
[]
)
=>
MaybePromise
<
number
|
bigint
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
name
display
Name
description
version
configure
health
Check
warnings
start
close
get
set
delete
touch
get
Many
set
Many
delete
Many
@valon-technologies/gestalt
Loading...
Runtime hooks required to implement a Gestalt cache provider.