edgekitjs - v0.0.51
GitHub
Preparing search index...
index
WorkerKVRateLimit
KV
Interface KV
interface
KV
{
delete
(
key
:
string
)
:
Promise
<
void
>
;
get
(
key
:
string
,
options
?:
Partial
<
KVNamespaceGetOptions
<
undefined
>
>
,
)
:
Promise
<
null
|
string
>
;
get
(
key
:
string
,
type
:
"text"
)
:
Promise
<
null
|
string
>
;
get
<
ExpectedValue
=
unknown
>
(
key
:
string
,
type
:
"json"
,
)
:
Promise
<
null
|
ExpectedValue
>
;
get
(
key
:
string
,
type
:
"arrayBuffer"
)
:
Promise
<
null
|
ArrayBuffer
>
;
get
(
key
:
string
,
type
:
"stream"
)
:
Promise
<
null
|
ReadableStream
<
any
>
>
;
get
(
key
:
string
,
options
?:
KVNamespaceGetOptions
<
"text"
>
,
)
:
Promise
<
null
|
string
>
;
get
<
ExpectedValue
=
unknown
>
(
key
:
string
,
options
?:
KVNamespaceGetOptions
<
"json"
>
,
)
:
Promise
<
null
|
ExpectedValue
>
;
get
(
key
:
string
,
options
?:
KVNamespaceGetOptions
<
"arrayBuffer"
>
,
)
:
Promise
<
null
|
ArrayBuffer
>
;
get
(
key
:
string
,
options
?:
KVNamespaceGetOptions
<
"stream"
>
,
)
:
Promise
<
null
|
ReadableStream
<
any
>
>
;
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
options
?:
Partial
<
KVNamespaceGetOptions
<
undefined
>
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
string
,
Metadata
>
>
;
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
type
:
"text"
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
string
,
Metadata
>
>
;
getWithMetadata
<
ExpectedValue
=
unknown
,
Metadata
=
unknown
>
(
key
:
string
,
type
:
"json"
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ExpectedValue
,
Metadata
>
>
;
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
type
:
"arrayBuffer"
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ArrayBuffer
,
Metadata
>
>
;
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
type
:
"stream"
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ReadableStream
<
any
>
,
Metadata
>
>
;
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
options
:
KVNamespaceGetOptions
<
"text"
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
string
,
Metadata
>
>
;
getWithMetadata
<
ExpectedValue
=
unknown
,
Metadata
=
unknown
>
(
key
:
string
,
options
:
KVNamespaceGetOptions
<
"json"
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ExpectedValue
,
Metadata
>
>
;
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
options
:
KVNamespaceGetOptions
<
"arrayBuffer"
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ArrayBuffer
,
Metadata
>
>
;
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
options
:
KVNamespaceGetOptions
<
"stream"
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ReadableStream
<
any
>
,
Metadata
>
>
;
list
<
Metadata
=
unknown
>
(
options
?:
KVNamespaceListOptions
,
)
:
Promise
<
KVNamespaceListResult
<
Metadata
,
string
>
>
;
put
(
key
:
string
,
value
:
|
string
|
ArrayBuffer
|
ArrayBufferView
<
ArrayBufferLike
>
|
ReadableStream
<
any
>
,
options
?:
KVNamespacePutOptions
,
)
:
Promise
<
void
>
;
}
Hierarchy
KVNamespace
KV
Index
Methods
delete
get
get
With
Metadata
list
put
Methods
delete
delete
(
key
:
string
)
:
Promise
<
void
>
Parameters
key
:
string
Returns
Promise
<
void
>
get
get
(
key
:
string
,
options
?:
Partial
<
KVNamespaceGetOptions
<
undefined
>
>
,
)
:
Promise
<
null
|
string
>
Parameters
key
:
string
Optional
options
:
Partial
<
KVNamespaceGetOptions
<
undefined
>
>
Returns
Promise
<
null
|
string
>
get
(
key
:
string
,
type
:
"text"
)
:
Promise
<
null
|
string
>
Parameters
key
:
string
type
:
"text"
Returns
Promise
<
null
|
string
>
get
<
ExpectedValue
=
unknown
>
(
key
:
string
,
type
:
"json"
,
)
:
Promise
<
null
|
ExpectedValue
>
Type Parameters
ExpectedValue
=
unknown
Parameters
key
:
string
type
:
"json"
Returns
Promise
<
null
|
ExpectedValue
>
get
(
key
:
string
,
type
:
"arrayBuffer"
)
:
Promise
<
null
|
ArrayBuffer
>
Parameters
key
:
string
type
:
"arrayBuffer"
Returns
Promise
<
null
|
ArrayBuffer
>
get
(
key
:
string
,
type
:
"stream"
)
:
Promise
<
null
|
ReadableStream
<
any
>
>
Parameters
key
:
string
type
:
"stream"
Returns
Promise
<
null
|
ReadableStream
<
any
>
>
get
(
key
:
string
,
options
?:
KVNamespaceGetOptions
<
"text"
>
,
)
:
Promise
<
null
|
string
>
Parameters
key
:
string
Optional
options
:
KVNamespaceGetOptions
<
"text"
>
Returns
Promise
<
null
|
string
>
get
<
ExpectedValue
=
unknown
>
(
key
:
string
,
options
?:
KVNamespaceGetOptions
<
"json"
>
,
)
:
Promise
<
null
|
ExpectedValue
>
Type Parameters
ExpectedValue
=
unknown
Parameters
key
:
string
Optional
options
:
KVNamespaceGetOptions
<
"json"
>
Returns
Promise
<
null
|
ExpectedValue
>
get
(
key
:
string
,
options
?:
KVNamespaceGetOptions
<
"arrayBuffer"
>
,
)
:
Promise
<
null
|
ArrayBuffer
>
Parameters
key
:
string
Optional
options
:
KVNamespaceGetOptions
<
"arrayBuffer"
>
Returns
Promise
<
null
|
ArrayBuffer
>
get
(
key
:
string
,
options
?:
KVNamespaceGetOptions
<
"stream"
>
,
)
:
Promise
<
null
|
ReadableStream
<
any
>
>
Parameters
key
:
string
Optional
options
:
KVNamespaceGetOptions
<
"stream"
>
Returns
Promise
<
null
|
ReadableStream
<
any
>
>
get
With
Metadata
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
options
?:
Partial
<
KVNamespaceGetOptions
<
undefined
>
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
string
,
Metadata
>
>
Type Parameters
Metadata
=
unknown
Parameters
key
:
string
Optional
options
:
Partial
<
KVNamespaceGetOptions
<
undefined
>
>
Returns
Promise
<
KVNamespaceGetWithMetadataResult
<
string
,
Metadata
>
>
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
type
:
"text"
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
string
,
Metadata
>
>
Type Parameters
Metadata
=
unknown
Parameters
key
:
string
type
:
"text"
Returns
Promise
<
KVNamespaceGetWithMetadataResult
<
string
,
Metadata
>
>
getWithMetadata
<
ExpectedValue
=
unknown
,
Metadata
=
unknown
>
(
key
:
string
,
type
:
"json"
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ExpectedValue
,
Metadata
>
>
Type Parameters
ExpectedValue
=
unknown
Metadata
=
unknown
Parameters
key
:
string
type
:
"json"
Returns
Promise
<
KVNamespaceGetWithMetadataResult
<
ExpectedValue
,
Metadata
>
>
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
type
:
"arrayBuffer"
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ArrayBuffer
,
Metadata
>
>
Type Parameters
Metadata
=
unknown
Parameters
key
:
string
type
:
"arrayBuffer"
Returns
Promise
<
KVNamespaceGetWithMetadataResult
<
ArrayBuffer
,
Metadata
>
>
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
type
:
"stream"
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ReadableStream
<
any
>
,
Metadata
>
>
Type Parameters
Metadata
=
unknown
Parameters
key
:
string
type
:
"stream"
Returns
Promise
<
KVNamespaceGetWithMetadataResult
<
ReadableStream
<
any
>
,
Metadata
>
>
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
options
:
KVNamespaceGetOptions
<
"text"
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
string
,
Metadata
>
>
Type Parameters
Metadata
=
unknown
Parameters
key
:
string
options
:
KVNamespaceGetOptions
<
"text"
>
Returns
Promise
<
KVNamespaceGetWithMetadataResult
<
string
,
Metadata
>
>
getWithMetadata
<
ExpectedValue
=
unknown
,
Metadata
=
unknown
>
(
key
:
string
,
options
:
KVNamespaceGetOptions
<
"json"
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ExpectedValue
,
Metadata
>
>
Type Parameters
ExpectedValue
=
unknown
Metadata
=
unknown
Parameters
key
:
string
options
:
KVNamespaceGetOptions
<
"json"
>
Returns
Promise
<
KVNamespaceGetWithMetadataResult
<
ExpectedValue
,
Metadata
>
>
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
options
:
KVNamespaceGetOptions
<
"arrayBuffer"
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ArrayBuffer
,
Metadata
>
>
Type Parameters
Metadata
=
unknown
Parameters
key
:
string
options
:
KVNamespaceGetOptions
<
"arrayBuffer"
>
Returns
Promise
<
KVNamespaceGetWithMetadataResult
<
ArrayBuffer
,
Metadata
>
>
getWithMetadata
<
Metadata
=
unknown
>
(
key
:
string
,
options
:
KVNamespaceGetOptions
<
"stream"
>
,
)
:
Promise
<
KVNamespaceGetWithMetadataResult
<
ReadableStream
<
any
>
,
Metadata
>
>
Type Parameters
Metadata
=
unknown
Parameters
key
:
string
options
:
KVNamespaceGetOptions
<
"stream"
>
Returns
Promise
<
KVNamespaceGetWithMetadataResult
<
ReadableStream
<
any
>
,
Metadata
>
>
list
list
<
Metadata
=
unknown
>
(
options
?:
KVNamespaceListOptions
,
)
:
Promise
<
KVNamespaceListResult
<
Metadata
,
string
>
>
Type Parameters
Metadata
=
unknown
Parameters
Optional
options
:
KVNamespaceListOptions
Returns
Promise
<
KVNamespaceListResult
<
Metadata
,
string
>
>
put
put
(
key
:
string
,
value
:
|
string
|
ArrayBuffer
|
ArrayBufferView
<
ArrayBufferLike
>
|
ReadableStream
<
any
>
,
options
?:
KVNamespacePutOptions
,
)
:
Promise
<
void
>
Parameters
key
:
string
value
:
string
|
ArrayBuffer
|
ArrayBufferView
<
ArrayBufferLike
>
|
ReadableStream
<
any
>
Optional
options
:
KVNamespacePutOptions
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
delete
get
get
With
Metadata
list
put
GitHub
edgekitjs - v0.0.51
Loading...