Skip to content

Commit 7659b3d

Browse files
kaadamhaesik
authored andcommitted
Fixed some typos in API documentation (#1935)
IoT.js-DCO-1.0-Signed-off-by: Adam Kallai [email protected]
1 parent 48bf8d9 commit 7659b3d

6 files changed

+10
-10
lines changed

docs/api/IoT.js-API-Events.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ IoT.js is based on event-driven programming where objects (called "emitters") pe
1919
# Class: EventEmitter
2020

2121
The `EventEmitter` plays a role as base class for "emitters".
22-
User application would not directly creates an instance of `EventEmitter` since `EventEmitter` is an abstract trait which defines its behavior and grants to sub-classes.
22+
User application would not directly create an instance of `EventEmitter` since `EventEmitter` is an abstract trait which defines its behavior and grants to sub-classes.
2323

2424
### new EventEmitter()
2525
* Returns {EventEmitter}.

docs/api/IoT.js-API-HTTP.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ server.listen(port, function() {
9999
* Returns: {http.ClientRequest}
100100

101101
The function creates a `http.ClientRequest` instance with the `options` defined.
102-
This can be used to get data form a server or to send data for a server.
102+
This can be used to get data from a server or to send data for a server.
103103

104104
In case of data send the `'Content-Length'` header should be specifed so the server can properly handle the request.
105105

docs/api/IoT.js-API-MQTT.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The QoS level can be 0, 1 or 2.
2020
- Level 1 means the packet arrives at least once (duplications might occur, it is the user's responsibility to take care of them).
2121
- Level 2 means that the package is delivered exactly once.
2222

23-
### Topic seperating and wildcarding
23+
### Topic separating and wildcarding
2424
Topics can be wildcarded and they also can be structured into multiple levels. These levels are divided by the `/` sign (eg. `iotjs/jerryscript/jerry-core`). There are multiple wildcarding possibilities:
2525
- `Multi-level wildcard` The `#` sign is a wildcard character that matches any number of levels within a topic. This character MUST be the last character in a topic name. Typing `iotjs/#` means the client subscribes to anything that is under the `iotjs` topic.
2626
- `Single-level wildcard` The `+` sign is a wildcard character that matches only one topic level. It can be used more at than one level in the topic name. It MUST be used so it occupies an entire level of the name. Typing `iotjs/+/jerry-core` subscribes you to `jerry-core` topic.
@@ -36,14 +36,14 @@ The `MQTTClient` can subscribe or publish data to a broker. It sends data over a
3636
- `host` {Buffer | string} The address of the broker.
3737
- `port` {number} The port of the broker.
3838
- `socket` {net.Socket | TLSSocket} If a `TLSSocket` is given for secure communication it is the user's responsibility to connect it to establish the TLS connection first. Otherwise the client automatically connects the socket to the server.
39-
- `username` {Buffer | string} Optional. Use username when onnecting to a broker.
39+
- `username` {Buffer | string} Optional. Use username when connecting to a broker.
4040
- `password` {Buffer | string} Optional. Use password authentication when connecting to a broker.
4141
- `keepalive` {number} Keepalive time in seconds. If no data is sent on the connection in the given time window the broker disconnects the client.
4242
- `will` {boolean} Optional. If this flag is set to `true`, a `message` and a `topic` must follow with a QoS value between 0 and 2.
4343
- `qos` {number} If `will` is set to `true`, the message will be sent with the given QoS.
4444
- `topic` {Buffer | string} Only processed when `will` is set to `true`. The topic the `message` should be sent to.
4545
- `message` {Buffer | string} Only processed when `will` is set to `true`. The message to be sent to the broker when connecting.
46-
- `callback` {function} the function which will be executed when the client successfuly connected to the broker.
46+
- `callback` {function} the function which will be executed when the client successfully connected to the broker.
4747

4848
Returns with an MQTTClient object and starts connecting to a broker. Emits a `connect` event after the connection is completed.
4949

@@ -153,7 +153,7 @@ Emitted when the client successfully connects to a broker.
153153
A `disconnect` event is emitted when the broker disconnects the client gracefully.
154154

155155
### `error`
156-
If an error occured an `error` event is emitted with the error data.
156+
If an error occurred an `error` event is emitted with the error data.
157157

158158
### `message`
159159
When data is received from the server a `message` event is emitted with a `data` object. It has the following properties:

docs/api/IoT.js-API-Process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ IoT.js will not exit till all `'exit'` event listeners are called.
126126
The `process.exit()` method call will force the process to exit as quickly as possible,
127127
ignoring if there is any asynchronous operations still pending.
128128

129-
In most situations, it is not necessary to explcitly call `process.exit()`. The IoT.js will exit on its own
129+
In most situations, it is not necessary to explicitly call `process.exit()`. The IoT.js will exit on its own
130130
if there is no additional work pending in the event loop. The `process.exitCode` property can be set
131131
to exit code when the process exits gracefully.
132132

docs/api/IoT.js-API-TLS.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ The method returns a special object containing the tls context and credential in
112112

113113
## Class: tls.Server
114114

115-
A server object repesenting a TLS server. Based on the `net.Server`.
115+
A server object representing a TLS server. Based on the `net.Server`.
116116
All events, methods and properties are inherited from the `net.Server`.
117117

118118
### new tls.Server([options][, secureConnectionListener])
@@ -121,7 +121,7 @@ All events, methods and properties are inherited from the `net.Server`.
121121
* `secureContext` {object} An special object containing the tls credential information.
122122
This should be only created via a `tls.createSecureContext()` call if needed. If not provided
123123
a secureContext will be created automatically, using the `options` object. No default value is provided.
124-
* Additonal options are from `tls.createSecureContext()`.
124+
* Additional options are from `tls.createSecureContext()`.
125125
* `secureConnectionListener` {Function}
126126
* `socket` {tls.TLSSocket}
127127
* Returns {tls.Server}

docs/api/IoT.js-API-Timers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,4 +89,4 @@ When called, requests that the IoT.js event loop should not exit as long as the
8989

9090
### timeout.unref()
9191

92-
When called, the active `Timeout` object will not force the IoT.js event loop to remain active. If there are no other scheduled activites, the process may exit, the process may exit before the `Timeout` object's callback is invoked.
92+
When called, the active `Timeout` object will not force the IoT.js event loop to remain active. If there are no other scheduled activities, the process may exit, the process may exit before the `Timeout` object's callback is invoked.

0 commit comments

Comments
 (0)