Search
Preparing search index...
The search index is not available
@nestjs/common
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
ClientMqtt
Class ClientMqtt
Hierarchy
ClientProxy
ClientMqtt
Index
Constructors
constructor
Properties
connection
logger
mqtt
Client
options
routing
Map
url
Methods
assign
Packet
Id
close
connect
connect$
create
Client
create
Observer
create
Response
Callback
dispatch
Event
emit
get
Ack
Pattern
Name
get
Options
Prop
get
Res
Pattern
Name
handle
Error
merge
Close
Event
normalize
Pattern
publish
send
Constructors
constructor
new
Client
Mqtt
(
options
:
any
)
:
ClientMqtt
Parameters
options:
any
Returns
ClientMqtt
Properties
Protected
connection
connection
:
Promise
<
any
>
Protected
logger
logger
:
any
= new Logger(ClientProxy.name)
Protected
mqtt
Client
mqtt
Client
:
MqttClient
Protected
options
options
:
any
Protected
routing
Map
routing
Map
:
any
= new Map<string, Function>()
Protected
url
url
:
string
Methods
Protected
assign
Packet
Id
assign
Packet
Id
(
packet
:
ReadPacket
)
:
ReadPacket
&
PacketId
Parameters
packet:
ReadPacket
Returns
ReadPacket
&
PacketId
close
close
(
)
:
void
Returns
void
connect
connect
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
Protected
connect$
connect$
(
instance
:
any
, errorEvent
?:
string
, connectEvent
?:
string
)
:
Observable
<
any
>
Parameters
instance:
any
Default value
errorEvent:
string
= ERROR_EVENT
Default value
connectEvent:
string
= CONNECT_EVENT
Returns
Observable
<
any
>
create
Client
create
Client
(
)
:
MqttClient
Returns
MqttClient
Protected
create
Observer
create
Observer<T>
(
observer
:
Observer
<
T
>
)
:
function
Type parameters
T
Parameters
observer:
Observer
<
T
>
Returns
function
(
packet
:
WritePacket
)
:
void
Parameters
packet:
WritePacket
Returns
void
create
Response
Callback
create
Response
Callback
(
)
:
function
Returns
function
(
channel
:
string
, buffer
:
Buffer
)
:
any
Parameters
channel:
string
buffer:
Buffer
Returns
any
Protected
dispatch
Event
dispatch
Event
(
packet
:
ReadPacket
)
:
Promise
<
any
>
Parameters
packet:
ReadPacket
Returns
Promise
<
any
>
emit
emit<TResult, TInput>
(
pattern
:
any
, data
:
TInput
)
:
Observable
<
TResult
>
Type parameters
TResult
TInput
Parameters
pattern:
any
data:
TInput
Returns
Observable
<
TResult
>
get
Ack
Pattern
Name
get
Ack
Pattern
Name
(
pattern
:
string
)
:
string
Parameters
pattern:
string
Returns
string
Protected
get
Options
Prop
get
Options
Prop<T>
(
obj
:
any
, prop
:
keyof T["options"]
, defaultValue
?:
any
)
:
any
Type parameters
T
:
object
Parameters
obj:
any
prop:
keyof T["options"]
Default value
defaultValue:
any
= undefined
Returns
any
get
Res
Pattern
Name
get
Res
Pattern
Name
(
pattern
:
string
)
:
string
Parameters
pattern:
string
Returns
string
handle
Error
handle
Error
(
client
:
MqttClient
)
:
void
Parameters
client:
MqttClient
Returns
void
merge
Close
Event
merge
Close
Event<T>
(
instance
:
MqttClient
, source$
:
Observable
<
T
>
)
:
Observable
<
T
>
Type parameters
T
Parameters
instance:
MqttClient
source$:
Observable
<
T
>
Returns
Observable
<
T
>
Protected
normalize
Pattern
normalize
Pattern<T>
(
pattern
:
T
)
:
string
Type parameters
T
Parameters
pattern:
T
Returns
string
Protected
publish
publish
(
partialPacket
:
ReadPacket
, callback
:
function
)
:
Function
Parameters
partialPacket:
ReadPacket
callback:
function
(
packet
:
WritePacket
)
:
any
Parameters
packet:
WritePacket
Returns
any
Returns
Function
send
send<TResult, TInput>
(
pattern
:
any
, data
:
TInput
)
:
Observable
<
TResult
>
Type parameters
TResult
TInput
Parameters
pattern:
any
data:
TInput
Returns
Observable
<
TResult
>
Globals
Client
Mqtt
constructor
connection
logger
mqtt
Client
options
routing
Map
url
assign
Packet
Id
close
connect
connect$
create
Client
create
Observer
create
Response
Callback
dispatch
Event
emit
get
Ack
Pattern
Name
get
Options
Prop
get
Res
Pattern
Name
handle
Error
merge
Close
Event
normalize
Pattern
publish
send
Generated using
TypeDoc