diff options
author | Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> | 2023-04-23 17:04:08 +0330 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-04-23 13:34:08 +0000 |
commit | 32e478d7c37a0296b2bf616ee2e39e81e4c8d694 (patch) | |
tree | ad48f5e5cc77af6a9f5a383d8fa134ba81ffacb5 /doc/api | |
parent | c6279690be54e89cc4e5e0d6782a6973d8019232 (diff) | |
download | node-new-32e478d7c37a0296b2bf616ee2e39e81e4c8d694.tar.gz |
doc: fix typos
PR-URL: https://github.com/nodejs/node/pull/47685
Reviewed-By: Michaƫl Zasso <targos@protonmail.com>
Reviewed-By: Debadree Chatterjee <debadree333@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/cli.md | 2 | ||||
-rw-r--r-- | doc/api/diagnostics_channel.md | 4 | ||||
-rw-r--r-- | doc/api/domain.md | 4 | ||||
-rw-r--r-- | doc/api/inspector.md | 4 | ||||
-rw-r--r-- | doc/api/n-api.md | 4 | ||||
-rw-r--r-- | doc/api/util.md | 2 | ||||
-rw-r--r-- | doc/api/wasi.md | 2 | ||||
-rw-r--r-- | doc/api/worker_threads.md | 2 |
8 files changed, 12 insertions, 12 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md index 2f5d422333..b4406bcec5 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -269,7 +269,7 @@ the path specified by `--snapshot-blob`. ```console $ echo "globalThis.foo = 'I am from the snapshot'" > snapshot.js -# Run snapshot.js to intialize the application and snapshot the +# Run snapshot.js to initialize the application and snapshot the # state of it into snapshot.blob. $ node --snapshot-blob snapshot.blob --build-snapshot snapshot.js diff --git a/doc/api/diagnostics_channel.md b/doc/api/diagnostics_channel.md index b1000554ce..b92ee0b014 100644 --- a/doc/api/diagnostics_channel.md +++ b/doc/api/diagnostics_channel.md @@ -567,7 +567,7 @@ applied to transform the message data before it becomes the context value for the store. The prior storage context is accessible from within the transform function in cases where context linking is required. -The context applied to the store should be accesible in any async code which +The context applied to the store should be accessible in any async code which continues from execution which began during the given function, however there are some situations in which [context loss][] may occur. @@ -956,7 +956,7 @@ channels.asyncStart.bindStore(myStore, (data) => { A TracingChannel is a collection of several diagnostics\_channels representing specific points in the execution lifecycle of a single traceable action. The -behaviour is split into five diagnostics\_channels consisting of `start`, +behavior is split into five diagnostics\_channels consisting of `start`, `end`, `asyncStart`, `asyncEnd`, and `error`. A single traceable action will share the same event object between all events, this can be helpful for managing correlation through a weakmap. diff --git a/doc/api/domain.md b/doc/api/domain.md index d88eeef741..e986b8ec85 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -212,7 +212,7 @@ If domains are in use, then all **new** `EventEmitter` objects (including Stream objects, requests, responses, etc.) will be implicitly bound to the active domain at the time of their creation. -Additionally, callbacks passed to lowlevel event loop requests (such as +Additionally, callbacks passed to low-level event loop requests (such as to `fs.open()`, or other callback-taking methods) will automatically be bound to the active domain. If they throw, then the domain will catch the error. @@ -409,7 +409,7 @@ specified emitter. * `...args` {any} Run the supplied function in the context of the domain, implicitly -binding all event emitters, timers, and lowlevel requests that are +binding all event emitters, timers, and low-level requests that are created in that context. Optionally, arguments can be passed to the function. diff --git a/doc/api/inspector.md b/doc/api/inspector.md index 8268d93139..dad72fdb76 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -54,7 +54,7 @@ Create a new instance of the `inspector.Session` class. The inspector session needs to be connected through [`session.connect()`][] before the messages can be dispatched to the inspector backend. -When using `Session`, the object outputed by the console API will not be +When using `Session`, the object outputted by the console API will not be released, unless we performed manually `Runtime.DiscardConsoleEntries` command. @@ -227,7 +227,7 @@ Create a new instance of the `inspector.Session` class. The inspector session needs to be connected through [`session.connect()`][] before the messages can be dispatched to the inspector backend. -When using `Session`, the object outputed by the console API will not be +When using `Session`, the object outputted by the console API will not be released, unless we performed manually `Runtime.DiscardConsoleEntries` command. diff --git a/doc/api/n-api.md b/doc/api/n-api.md index df229ed516..42598c6fdb 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -37,7 +37,7 @@ Node-API is a C API that ensures ABI stability across Node.js versions and different compiler levels. A C++ API can be easier to use. To support using C++, the project maintains a C++ wrapper module called [`node-addon-api`][]. -This wrapper provides an inlineable C++ API. Binaries built +This wrapper provides an inlinable C++ API. Binaries built with `node-addon-api` will depend on the symbols for the Node-API C-based functions exported by Node.js. `node-addon-api` is a more efficient way to write code that calls Node-API. Take, for example, the @@ -542,7 +542,7 @@ the call will succeed and `data` will be set to `NULL`. ## Basic Node-API data types -Node-API exposes the following fundamental datatypes as abstractions that are +Node-API exposes the following fundamental data types as abstractions that are consumed by the various APIs. These APIs should be treated as opaque, introspectable only with other Node-API calls. diff --git a/doc/api/util.md b/doc/api/util.md index e0a296ec26..b13fdf80c9 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -1481,7 +1481,7 @@ console.log(values, positionals); ### `parseArgs` `tokens` -Detailed parse information is available for adding custom behaviours by +Detailed parse information is available for adding custom behaviors by specifying `tokens: true` in the configuration. The returned tokens have properties describing: diff --git a/doc/api/wasi.md b/doc/api/wasi.md index 5a183e0c7a..a4171c4a6d 100644 --- a/doc/api/wasi.md +++ b/doc/api/wasi.md @@ -141,7 +141,7 @@ changes: the real paths to those directories on the host machine. * `returnOnExit` {boolean} By default, when WASI applications call `__wasi_proc_exit()` `wasi.start()` will return with the exit code - specified rather than terminatng the process. Setting this option to + specified rather than terminating the process. Setting this option to `false` will cause the Node.js process to exit with the specified exit code instead. **Default:** `true`. * `stdin` {integer} The file descriptor used as standard input in the diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 0d585965b8..f3f500c907 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -1011,7 +1011,7 @@ changes: * `stackSizeMb` {number} The default maximum stack size for the thread. Small values may lead to unusable Worker instances. **Default:** `4`. * `name` {string} An optional `name` to be appended to the worker title - for debuggin/identification purposes, making the final title as + for debugging/identification purposes, making the final title as `[worker ${id}] ${name}`. **Default:** `''`. ### Event: `'error'` |