Search
Preparing search index...
The search index is not available
@nestjs/common
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
ServerRedis
Class ServerRedis
Hierarchy
Server
ServerRedis
Implements
any
Index
Constructors
constructor
Properties
is
Explicitly
Terminated
logger
message
Handlers
options
pub
Client
sub
Client
url
Methods
add
Handler
bind
Events
close
create
Redis
Client
create
Retry
Strategy
deserialize
get
Ack
Queue
Name
get
Client
Options
get
Handler
ByPattern
get
Handlers
get
Message
Handler
get
Options
Prop
get
Publisher
get
Res
Queue
Name
handle
Error
handle
Event
handle
Message
listen
load
Package
send
start
transform
ToObservable
Constructors
constructor
new
Server
Redis
(
options
:
object
)
:
ServerRedis
Parameters
options:
object
Optional
retry
Attempts
?:
number
Optional
retry
Delay
?:
number
Optional
url
?:
string
Returns
ServerRedis
Properties
Private
is
Explicitly
Terminated
is
Explicitly
Terminated
:
boolean
= false
Protected
logger
logger
:
any
= new Logger(Server.name)
Protected
message
Handlers
message
Handlers
:
any
= new Map<string, MessageHandler>()
Private
options
options
:
object
Type declaration
Optional
retry
Attempts
?:
number
Optional
retry
Delay
?:
number
Optional
url
?:
string
Private
pub
Client
pub
Client
:
RedisClient
Private
sub
Client
sub
Client
:
RedisClient
Private
url
url
:
string
Methods
add
Handler
add
Handler
(
pattern
:
any
, callback
:
MessageHandler
, isEventHandler
?:
boolean
)
:
void
Parameters
pattern:
any
callback:
MessageHandler
Default value
isEventHandler:
boolean
= false
Returns
void
bind
Events
bind
Events
(
subClient
:
RedisClient
, pubClient
:
RedisClient
)
:
void
Parameters
subClient:
RedisClient
pubClient:
RedisClient
Returns
void
close
close
(
)
:
void
Returns
void
create
Redis
Client
create
Redis
Client
(
)
:
RedisClient
Returns
RedisClient
create
Retry
Strategy
create
Retry
Strategy
(
options
:
RetryStrategyOptions
)
:
undefined
|
number
|
void
Parameters
options:
RetryStrategyOptions
Returns
undefined
|
number
|
void
deserialize
deserialize
(
content
:
any
)
:
ReadPacket
&
PacketId
Parameters
content:
any
Returns
ReadPacket
&
PacketId
get
Ack
Queue
Name
get
Ack
Queue
Name
(
pattern
:
string
)
:
string
Parameters
pattern:
string
Returns
string
get
Client
Options
get
Client
Options
(
)
:
Partial
<
ClientOpts
>
Returns
Partial
<
ClientOpts
>
get
Handler
ByPattern
get
Handler
ByPattern
(
pattern
:
string
)
:
MessageHandler
|
null
Parameters
pattern:
string
Returns
MessageHandler
|
null
get
Handlers
get
Handlers
(
)
:
Map
<
string
,
MessageHandler
>
Returns
Map
<
string
,
MessageHandler
>
get
Message
Handler
get
Message
Handler
(
pub
:
RedisClient
)
:
(Anonymous function)
Parameters
pub:
RedisClient
Returns
(Anonymous function)
get
Options
Prop
get
Options
Prop<T, K>
(
obj
:
T
, prop
:
K
, defaultValue
?:
T[K]
)
:
T[K]
Type parameters
T
:
any
K
:
keyof T
Parameters
obj:
T
prop:
K
Default value
defaultValue:
T[K]
= undefined
Returns
T[K]
get
Publisher
get
Publisher
(
pub
:
RedisClient
, pattern
:
any
, id
:
string
)
:
(Anonymous function)
Parameters
pub:
RedisClient
pattern:
any
id:
string
Returns
(Anonymous function)
get
Res
Queue
Name
get
Res
Queue
Name
(
pattern
:
string
)
:
string
Parameters
pattern:
string
Returns
string
handle
Error
handle
Error
(
stream
:
any
)
:
void
Parameters
stream:
any
Returns
void
handle
Event
handle
Event
(
pattern
:
string
, packet
:
ReadPacket
)
:
Promise
<
any
>
Parameters
pattern:
string
packet:
ReadPacket
Returns
Promise
<
any
>
handle
Message
handle
Message
(
channel
:
string
, buffer
:
string
|
any
, pub
:
RedisClient
)
:
Promise
<
any
>
Parameters
channel:
string
buffer:
string
|
any
pub:
RedisClient
Returns
Promise
<
any
>
listen
listen
(
callback
:
function
)
:
void
Parameters
callback:
function
(
)
:
void
Returns
void
Returns
void
Protected
load
Package
load
Package<T>
(
name
:
string
, ctx
:
string
, loader
?:
Function
)
:
T
Type parameters
T
Parameters
name:
string
ctx:
string
Optional
loader:
Function
Returns
T
send
send
(
stream$
:
Observable
<
any
>
, respond
:
function
)
:
Subscription
Parameters
stream$:
Observable
<
any
>
respond:
function
(
data
:
WritePacket
)
:
void
Parameters
data:
WritePacket
Returns
void
Returns
Subscription
start
start
(
callback
?:
function
)
:
void
Parameters
Optional
callback:
function
(
)
:
void
Returns
void
Returns
void
transform
ToObservable
transform
ToObservable<T>
(
resultOrDeffered
:
any
)
:
Observable
<
T
>
Type parameters
T
Parameters
resultOrDeffered:
any
Returns
Observable
<
T
>
Globals
Server
Redis
constructor
is
Explicitly
Terminated
logger
message
Handlers
options
pub
Client
sub
Client
url
add
Handler
bind
Events
close
create
Redis
Client
create
Retry
Strategy
deserialize
get
Ack
Queue
Name
get
Client
Options
get
Handler
ByPattern
get
Handlers
get
Message
Handler
get
Options
Prop
get
Publisher
get
Res
Queue
Name
handle
Error
handle
Event
handle
Message
listen
load
Package
send
start
transform
ToObservable
Generated using
TypeDoc