Skip to content

Commit 35b6571

Browse files
authored
Fix: some typos in documentation (#826)
1 parent 8983383 commit 35b6571

15 files changed

+22
-22
lines changed

doc/async_context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ void MakeCallbackWithAsyncContext(const Napi::CallbackInfo& info) {
7373
Napi::Function callback = info[0].As<Napi::Function>();
7474
Napi::Object resource = info[1].As<Napi::Object>();
7575

76-
// Creat a new async context instance.
76+
// Create a new async context instance.
7777
Napi::AsyncContext context(info.Env(), "async_context_test", resource);
7878

7979
// Invoke the callback with the async context instance.

doc/async_worker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ class EchoWorker : public AsyncWorker {
395395
};
396396
```
397397

398-
The `EchoWorker`'s contructor calls the base class' constructor to pass in the
398+
The `EchoWorker`'s constructor calls the base class' constructor to pass in the
399399
callback that the `Napi::AsyncWorker` base class will store persistently. When
400400
the work on the `Napi::AsyncWorker::Execute` method is done the
401401
`Napi::AsyncWorker::OnOk` method is called and the results return back to

doc/boolean.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Napi::Boolean::Boolean();
1818

1919
Returns a new _empty_ `Napi::Boolean` object.
2020

21-
### Contructor
21+
### Constructor
2222

2323
Creates a new instance of the `Napi::Boolean` object.
2424

doc/checker-tool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ indicating for each addon whether it is an N-API addon.
2626
```
2727
2828
The tool accepts the root directory from which to start checking for Node.js
29-
native addons as a single optional command line parameter. If ommitted it will
29+
native addons as a single optional command line parameter. If omitted it will
3030
start checking from the current directory (`.`).
3131
3232
[checker tool]: ../tools/check-napi.js

doc/creating_a_release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ the route folder of the repo launch the following command:
3636
```bash
3737
> changelog-maker
3838
```
39-
* Use the output generated by **changelog maker** to pdate the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/CHANGELOG.md)
39+
* Use the output generated by **changelog maker** to update the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/CHANGELOG.md)
4040
following the style used in publishing the previous release.
4141

4242
* Add any new contributors to the "contributors" section in the package.json

doc/escapable_handle_scope.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Napi::EscapableHandleScope::~EscapableHandleScope();
5959

6060
Deletes the `Napi::EscapableHandleScope` instance and allows any objects/handles created
6161
in the scope to be collected by the garbage collector. There is no
62-
guarantee as to when the gargbage collector will do this.
62+
guarantee as to when the garbage collector will do this.
6363

6464
### Escape
6565

doc/function.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Napi::Object Napi::Function::New(const std::initializer_list<napi_value>& args)
218218
```
219219

220220
- `[in] args`: Initializer list of JavaScript values as `napi_value` representing
221-
the arguments of the contructor function.
221+
the arguments of the constructor function.
222222

223223
Returns a new JavaScript object.
224224

@@ -245,7 +245,7 @@ object.
245245
Napi::Object Napi::Function::New(size_t argc, const napi_value* args) const;
246246
```
247247

248-
- `[in] argc`: The number of the arguments passed to the contructor function.
248+
- `[in] argc`: The number of the arguments passed to the constructor function.
249249
- `[in] args`: Array of JavaScript values as `napi_value` representing the
250250
arguments of the constructor function.
251251

doc/function_reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Napi::Object Napi::FunctionReference::New(const std::initializer_list<napi_value
7373
```
7474

7575
- `[in] args`: Initializer list of JavaScript values as `napi_value` representing
76-
the arguments of the contructor function.
76+
the arguments of the constructor function.
7777

7878
Returns a new JavaScript object.
7979

doc/handle_scope.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Napi::HandleScope::~HandleScope();
5454

5555
Deletes the `Napi::HandleScope` instance and allows any objects/handles created
5656
in the scope to be collected by the garbage collector. There is no
57-
guarantee as to when the gargbage collector will do this.
57+
guarantee as to when the garbage collector will do this.
5858

5959
### Env
6060

doc/number.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Napi::Number();
1616

1717
Returns a new _empty_ `Napi::Number` object.
1818

19-
### Contructor
19+
### Constructor
2020

2121
Creates a new instance of a `Napi::Number` object.
2222

0 commit comments

Comments
 (0)