Monarch Database API - v1.0.0
Preparing search index...
StreamOperations
Interface StreamOperations
interface
StreamOperations
{
xadd
(
key
:
string
,
id
:
string
,
fields
:
Record
<
string
,
any
>
,
)
:
Promise
<
string
>
;
xdel
(
key
:
string
,
ids
:
string
[]
)
:
Promise
<
number
>
;
xlen
(
key
:
string
)
:
Promise
<
number
>
;
xrange
(
key
:
string
,
start
:
string
,
end
:
string
,
count
?:
number
,
)
:
Promise
<
StreamEntry
[]
>
;
xread
(
streams
:
Record
<
string
,
string
>
,
count
?:
number
,
block
?:
number
,
)
:
Promise
<
Record
<
string
,
StreamEntry
[]
>
>
;
xrevrange
(
key
:
string
,
end
:
string
,
start
:
string
,
count
?:
number
,
)
:
Promise
<
StreamEntry
[]
>
;
xtrim
(
key
:
string
,
strategy
:
"maxlen"
|
"minid"
,
threshold
:
string
|
number
,
)
:
Promise
<
number
>
;
}
Implemented by
DataStructures
Index
Methods
xadd
xdel
xlen
xrange
xread
xrevrange
xtrim
Methods
xadd
xadd
(
key
:
string
,
id
:
string
,
fields
:
Record
<
string
,
any
>
)
:
Promise
<
string
>
Parameters
key
:
string
id
:
string
fields
:
Record
<
string
,
any
>
Returns
Promise
<
string
>
xdel
xdel
(
key
:
string
,
ids
:
string
[]
)
:
Promise
<
number
>
Parameters
key
:
string
ids
:
string
[]
Returns
Promise
<
number
>
xlen
xlen
(
key
:
string
)
:
Promise
<
number
>
Parameters
key
:
string
Returns
Promise
<
number
>
xrange
xrange
(
key
:
string
,
start
:
string
,
end
:
string
,
count
?:
number
,
)
:
Promise
<
StreamEntry
[]
>
Parameters
key
:
string
start
:
string
end
:
string
Optional
count
:
number
Returns
Promise
<
StreamEntry
[]
>
xread
xread
(
streams
:
Record
<
string
,
string
>
,
count
?:
number
,
block
?:
number
,
)
:
Promise
<
Record
<
string
,
StreamEntry
[]
>
>
Parameters
streams
:
Record
<
string
,
string
>
Optional
count
:
number
Optional
block
:
number
Returns
Promise
<
Record
<
string
,
StreamEntry
[]
>
>
xrevrange
xrevrange
(
key
:
string
,
end
:
string
,
start
:
string
,
count
?:
number
,
)
:
Promise
<
StreamEntry
[]
>
Parameters
key
:
string
end
:
string
start
:
string
Optional
count
:
number
Returns
Promise
<
StreamEntry
[]
>
xtrim
xtrim
(
key
:
string
,
strategy
:
"maxlen"
|
"minid"
,
threshold
:
string
|
number
,
)
:
Promise
<
number
>
Parameters
key
:
string
strategy
:
"maxlen"
|
"minid"
threshold
:
string
|
number
Returns
Promise
<
number
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
xadd
xdel
xlen
xrange
xread
xrevrange
xtrim
Monarch Database API - v1.0.0
Loading...