You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
2
2
# React MQTT Workflow Manager
3
3
4
-
React MQTT Workflow Manager is a React component library designed to wrap all [MQTT](https://mqtt.org/) sublogic behind the scenes. It deals only with events, no commands. The manager comunicates with your broker to dispatch actions in your front-end application. The library is focused to work with [Workflow API Layer](https://github.com/flow-build/workflow-api).
4
+
React MQTT Workflow Manager is a React component library designed to wrap all the [MQTT](https://mqtt.org/) sub-logic behind the scenes and must be used to work with [Workflow API Layer](https://github.com/flow-build/workflow-api). It only deals with events, not commands. The manager communicates with your broker to dispatch actions in your front-end application.
5
5
6
6
## Table of contents
7
7
@@ -36,7 +36,7 @@ npm i react@18 react-dom@18
36
36
## [Usage](usage)
37
37
38
38
39
-
1. Before the componente usage, set the store with `WorkflowManagerConfig.setStore`.
39
+
1. Before using the component, set the store with `WorkflowManagerConfig.setStore`.
The library also exposes methods and utilities for your commodity. They can be used out of the context of react components.
119
+
The library also provides methods and utilities for your commodity. They can be used outside the context of react components.
120
120
121
121
### setStore(store)
122
122
123
-
The library use your redux store to dispatch actions. This is used to dispatch internal actions control and for your applications.
123
+
The library uses your redux store to dispatch actions. This is used to control and dispatch internal actions for your application.
124
124
125
125
### getMqttClient()
126
126
127
-
A utility method to be used out of context to react components. Be careful; the method must be able to return `null` if an error happens when setting connect. [See here](https://github.com/mqttjs/MQTT.js/blob/main/README.md#client).
127
+
A utility method that can be used outside the context of react components. Be careful; the method must be able to return `null` if an error occurs when setting connect. See client config [here](https://github.com/mqttjs/MQTT.js/blob/main/README.md#client).
Works like exactly like [mqtt#subscribe](https://github.com/mqttjs/MQTT.js/blob/main/README.md#mqttclientsubscribetopictopic-arraytopic-object-options-callback), but the library implements validations and internal rules.
131
+
Works exactly like [mqtt#subscribe](https://github.com/mqttjs/MQTT.js/blob/main/README.md#mqttclientsubscribetopictopic-arraytopic-object-options-callback), but the library implements validations and internal rules.
Works like exactly like [mqtt#unsubscribe](https://github.com/mqttjs/MQTT.js/blob/main/README.md#mqttclientunsubscribetopictopic-array-options-callback), but the library implements validations and internal rules.
135
+
Works exactly like [mqtt#unsubscribe](https://github.com/mqttjs/MQTT.js/blob/main/README.md#mqttclientunsubscribetopictopic-array-options-callback), but the library implements validations and internal rules.
136
136
137
137
## [Hooks](hooks)
138
138
@@ -144,15 +144,15 @@ The hook returns a object contaning `client`, `status` and `error`.
144
144
145
145
Property | Type | Default value | Description
146
146
--- | --- | --- | ---
147
-
`client` | *MqttClient* | `null` | See type[here](https://github.com/mqttjs/MQTT.js/blob/main/types/lib/client.d.ts)
147
+
`client` | *MqttClient* | `null` | See client[here](https://github.com/mqttjs/MQTT.js/blob/main/types/lib/client.d.ts).
0 commit comments