Skip to content

Commit 8850997

Browse files
authored
doc: fix typo AsyncProgressWorker::ExecutionProgress (#1350)
1 parent 0c093a3 commit 8850997

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

doc/async_worker_variants.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ virtual void Napi::AsyncProgressWorker::OnOK();
5252
### OnProgress
5353

5454
This method is invoked when the computation in the
55-
`Napi::AsyncProgressWorker::ExecutionProcess::Send` method was called during
55+
`Napi::AsyncProgressWorker::ExecutionProgress::Send` method was called during
5656
worker thread execution. This method can also be triggered via a call to
57-
`Napi::AsyncProgress[Queue]Worker::ExecutionProcess::Signal`, in which case the
57+
`Napi::AsyncProgress[Queue]Worker::ExecutionProgress::Signal`, in which case the
5858
`data` parameter will be `nullptr`.
5959

6060
```cpp
@@ -227,40 +227,40 @@ unexpected upcoming thread safe calls.
227227
virtual Napi::AsyncProgressWorker::~AsyncProgressWorker();
228228
```
229229

230-
# AsyncProgressWorker::ExecutionProcess
230+
# AsyncProgressWorker::ExecutionProgress
231231

232232
A bridge class created before the worker thread execution of `Napi::AsyncProgressWorker::Execute`.
233233

234234
## Methods
235235

236236
### Send
237237

238-
`Napi::AsyncProgressWorker::ExecutionProcess::Send` takes two arguments, a pointer
238+
`Napi::AsyncProgressWorker::ExecutionProgress::Send` takes two arguments, a pointer
239239
to a generic type of data, and a `size_t` to indicate how many items the pointer is
240240
pointing to.
241241

242242
The data pointed to will be copied to internal slots of `Napi::AsyncProgressWorker` so
243-
after the call to `Napi::AsyncProgressWorker::ExecutionProcess::Send` the data can
243+
after the call to `Napi::AsyncProgressWorker::ExecutionProgress::Send` the data can
244244
be safely released.
245245

246-
Note that `Napi::AsyncProgressWorker::ExecutionProcess::Send` merely guarantees
246+
Note that `Napi::AsyncProgressWorker::ExecutionProgress::Send` merely guarantees
247247
**eventual** invocation of `Napi::AsyncProgressWorker::OnProgress`, which means
248248
multiple send might be coalesced into single invocation of `Napi::AsyncProgressWorker::OnProgress`
249249
with latest data. If you would like to guarantee that there is one invocation of
250250
`OnProgress` for every `Send` call, you should use the `Napi::AsyncProgressQueueWorker`
251251
class instead which is documented further down this page.
252252

253253
```cpp
254-
void Napi::AsyncProgressWorker::ExecutionProcess::Send(const T* data, size_t count) const;
254+
void Napi::AsyncProgressWorker::ExecutionProgress::Send(const T* data, size_t count) const;
255255
```
256256
257257
### Signal
258258
259-
`Napi::AsyncProgressWorker::ExecutionProcess::Signal` triggers an invocation of
259+
`Napi::AsyncProgressWorker::ExecutionProgress::Signal` triggers an invocation of
260260
`Napi::AsyncProgressWorker::OnProgress` with `nullptr` as the `data` parameter.
261261
262262
```cpp
263-
void Napi::AsyncProgressWorker::ExecutionProcess::Signal();
263+
void Napi::AsyncProgressWorker::ExecutionProgress::Signal();
264264
```
265265

266266
## Example
@@ -402,38 +402,38 @@ thread in the order it was committed.
402402
For the most basic use, only the `Napi::AsyncProgressQueueWorker::Execute` and
403403
`Napi::AsyncProgressQueueWorker::OnProgress` method must be implemented in a subclass.
404404

405-
# AsyncProgressQueueWorker::ExecutionProcess
405+
# AsyncProgressQueueWorker::ExecutionProgress
406406

407407
A bridge class created before the worker thread execution of `Napi::AsyncProgressQueueWorker::Execute`.
408408

409409
## Methods
410410

411411
### Send
412412

413-
`Napi::AsyncProgressQueueWorker::ExecutionProcess::Send` takes two arguments, a pointer
413+
`Napi::AsyncProgressQueueWorker::ExecutionProgress::Send` takes two arguments, a pointer
414414
to a generic type of data, and a `size_t` to indicate how many items the pointer is
415415
pointing to.
416416

417417
The data pointed to will be copied to internal slots of `Napi::AsyncProgressQueueWorker` so
418-
after the call to `Napi::AsyncProgressQueueWorker::ExecutionProcess::Send` the data can
418+
after the call to `Napi::AsyncProgressQueueWorker::ExecutionProgress::Send` the data can
419419
be safely released.
420420

421-
`Napi::AsyncProgressQueueWorker::ExecutionProcess::Send` guarantees invocation
421+
`Napi::AsyncProgressQueueWorker::ExecutionProgress::Send` guarantees invocation
422422
of `Napi::AsyncProgressQueueWorker::OnProgress`, which means multiple `Send`
423423
call will result in the in-order invocation of `Napi::AsyncProgressQueueWorker::OnProgress`
424424
with each data item.
425425

426426
```cpp
427-
void Napi::AsyncProgressQueueWorker::ExecutionProcess::Send(const T* data, size_t count) const;
427+
void Napi::AsyncProgressQueueWorker::ExecutionProgress::Send(const T* data, size_t count) const;
428428
```
429429
430430
### Signal
431431
432-
`Napi::AsyncProgressQueueWorker::ExecutionProcess::Signal` triggers an invocation of
432+
`Napi::AsyncProgressQueueWorker::ExecutionProgress::Signal` triggers an invocation of
433433
`Napi::AsyncProgressQueueWorker::OnProgress` with `nullptr` as the `data` parameter.
434434
435435
```cpp
436-
void Napi::AsyncProgressQueueWorker::ExecutionProcess::Signal() const;
436+
void Napi::AsyncProgressQueueWorker::ExecutionProgress::Signal() const;
437437
```
438438

439439
## Example

0 commit comments

Comments
 (0)