redis-loader
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Scan
Stream
constructor
_command
_count
_key
_match
_next
Cursor
_opts
_redis
readable
default
Max
Listeners
_ending
Push
_read
add
Listener
emit
emit
Error
event
Names
get
Max
Listeners
is
Paused
listener
Count
listeners
on
once
pause
pipe
prepend
Listener
prepend
Once
Listener
promise
push
read
remove
All
Listeners
remove
Listener
resume
set
Encoding
set
Max
Listeners
unpipe
unshift
wrap
listener
Count
Scan
Stream
Options
Hierarchy
ReadStream
ScanStream
Implements
ReadableStream
IBluestream
Index
Constructors
constructor
Properties
_command
_count
_key
_match
_next
Cursor
_opts
_redis
readable
default
Max
Listeners
Methods
_ending
Push
_read
add
Listener
emit
emit
Error
event
Names
get
Max
Listeners
is
Paused
listener
Count
listeners
on
once
pause
pipe
prepend
Listener
prepend
Once
Listener
promise
push
read
remove
All
Listeners
remove
Listener
resume
set
Encoding
set
Max
Listeners
unpipe
unshift
wrap
listener
Count
Constructors
constructor
new
Scan
Stream
(
__namedParameters
:
object
)
:
ScanStream
Parameters
__namedParameters:
object
command
:
"scan"
|
"sscan"
|
"hscan"
|
"zscan"
|
"scanBuffer"
|
"sscanBuffer"
|
"hscanBuffer"
|
"zscanBuffer"
count
:
string
key
:
string
match
:
string
opts
:
opts
redis
:
Redis
Returns
ScanStream
Properties
Private
_command
_command
:
string
Private
_count
_count
:
string
Private
_key
_key
:
string
Private
_match
_match
:
string
Private
_next
Cursor
_next
Cursor
:
string
Private
_opts
_opts
:
IReadableStreamOptions
Private
_redis
_redis
:
Redis
readable
readable
:
boolean
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
_ending
Push
_ending
Push
(
)
:
void
Returns
void
_read
_read
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
add
Listener
add
Listener
(
event
:
string
, listener
:
Function
)
:
this
add
Listener
(
event
:
"close"
, listener
:
function
)
:
this
add
Listener
(
event
:
"data"
, listener
:
function
)
:
this
add
Listener
(
event
:
"end"
, listener
:
function
)
:
this
add
Listener
(
event
:
"readable"
, listener
:
function
)
:
this
add
Listener
(
event
:
"error"
, listener
:
function
)
:
this
Event emitter The defined events on documents including:
close
data
end
readable
error
Parameters
event:
string
listener:
Function
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"data"
listener:
function
(
chunk
:
Buffer
|
string
)
:
void
Parameters
chunk:
Buffer
|
string
Returns
void
Returns
this
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"readable"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
emit
emit
(
event
:
string
|
symbol
,
...
args
:
any
[]
)
:
boolean
emit
(
event
:
"close"
)
:
boolean
emit
(
event
:
"data"
, chunk
:
Buffer
|
string
)
:
boolean
emit
(
event
:
"end"
)
:
boolean
emit
(
event
:
"readable"
)
:
boolean
emit
(
event
:
"error"
, err
:
Error
)
:
boolean
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
Parameters
event:
"close"
Returns
boolean
Parameters
event:
"data"
chunk:
Buffer
|
string
Returns
boolean
Parameters
event:
"end"
Returns
boolean
Parameters
event:
"readable"
Returns
boolean
Parameters
event:
"error"
err:
Error
Returns
boolean
emit
Error
emit
Error
(
e
:
any
)
:
void
Parameters
e:
any
Returns
void
event
Names
event
Names
(
)
:
(
string
|
symbol
)
[]
Returns
(
string
|
symbol
)
[]
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
is
Paused
is
Paused
(
)
:
boolean
Returns
boolean
listener
Count
listener
Count
(
type
:
string
|
symbol
)
:
number
Parameters
type:
string
|
symbol
Returns
number
listeners
listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
on
on
(
event
:
string
, listener
:
Function
)
:
this
on
(
event
:
"close"
, listener
:
function
)
:
this
on
(
event
:
"data"
, listener
:
function
)
:
this
on
(
event
:
"end"
, listener
:
function
)
:
this
on
(
event
:
"readable"
, listener
:
function
)
:
this
on
(
event
:
"error"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
Function
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"data"
listener:
function
(
chunk
:
Buffer
|
string
)
:
void
Parameters
chunk:
Buffer
|
string
Returns
void
Returns
this
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"readable"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
once
once
(
event
:
string
, listener
:
Function
)
:
this
once
(
event
:
"close"
, listener
:
function
)
:
this
once
(
event
:
"data"
, listener
:
function
)
:
this
once
(
event
:
"end"
, listener
:
function
)
:
this
once
(
event
:
"readable"
, listener
:
function
)
:
this
once
(
event
:
"error"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
Function
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"data"
listener:
function
(
chunk
:
Buffer
|
string
)
:
void
Parameters
chunk:
Buffer
|
string
Returns
void
Returns
this
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"readable"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
pause
pause
(
)
:
this
Returns
this
pipe
pipe<T>
(
destination
:
T
, options
?:
object
)
:
T
Type parameters
T
:
WritableStream
Parameters
destination:
T
Optional
options:
object
Optional
end
?:
boolean
Returns
T
prepend
Listener
prepend
Listener
(
event
:
string
, listener
:
Function
)
:
this
prepend
Listener
(
event
:
"close"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"data"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"end"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"readable"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"error"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
Function
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"data"
listener:
function
(
chunk
:
Buffer
|
string
)
:
void
Parameters
chunk:
Buffer
|
string
Returns
void
Returns
this
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"readable"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
, listener
:
Function
)
:
this
prepend
Once
Listener
(
event
:
"close"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"data"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"end"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"readable"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"error"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
Function
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"data"
listener:
function
(
chunk
:
Buffer
|
string
)
:
void
Parameters
chunk:
Buffer
|
string
Returns
void
Returns
this
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"readable"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
promise
promise
(
)
:
any
Returns
any
push
push
(
data
:
any
)
:
boolean
Parameters
data:
any
Returns
boolean
read
read
(
size
?:
number
)
:
any
Parameters
Optional
size:
number
Returns
any
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
:
this
Parameters
Optional
event:
string
|
symbol
Returns
this
remove
Listener
remove
Listener
(
event
:
string
, listener
:
Function
)
:
this
remove
Listener
(
event
:
"close"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"data"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"end"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"readable"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"error"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
Function
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"data"
listener:
function
(
chunk
:
Buffer
|
string
)
:
void
Parameters
chunk:
Buffer
|
string
Returns
void
Returns
this
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"readable"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
resume
resume
(
)
:
this
Returns
this
set
Encoding
set
Encoding
(
encoding
:
string
)
:
this
Parameters
encoding:
string
Returns
this
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
unpipe
unpipe<T>
(
destination
?:
T
)
:
this
Type parameters
T
:
WritableStream
Parameters
Optional
destination:
T
Returns
this
unshift
unshift
(
chunk
:
any
)
:
void
Parameters
chunk:
any
Returns
void
wrap
wrap
(
oldStream
:
ReadableStream
)
:
Readable
Parameters
oldStream:
ReadableStream
Returns
Readable
Static
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Generated using
TypeDoc
Event emitter The defined events on documents including: