diff options
author | jeromewu <jeromewus@gmail.com> | 2020-06-15 09:55:53 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-06-15 09:55:53 +0300 |
commit | cc1f2bfe81024d08204b53c3cc837d702b80b40f (patch) | |
tree | 1356b807f0cd7083cfd734376a64011e7a7b40a5 | |
parent | fcd01ceb325ef8c63ae126586521205848269c2d (diff) | |
parent | 6ef2e116cd4ab5f2812ebd07993677d629b081bc (diff) |
Merge pull request #456 from isc/patch-1
Correct some typing errors in api.md
-rw-r--r-- | docs/api.md | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/docs/api.md b/docs/api.md index 6a4957d..f66e359 100644 --- a/docs/api.md +++ b/docs/api.md @@ -325,11 +325,7 @@ const { createWorker } = Tesseract; <a name="worker-terminate"></a> ### Worker.terminate(jobId): Promise -Worker.terminate() terminates the worker and clean up - -**Arguments:** - -- `jobId` Please see details above +Worker.terminate() terminates the worker and cleans up ```javascript (async () => { @@ -340,7 +336,7 @@ Worker.terminate() terminates the worker and clean up <a name="create-scheduler"></a> ## createScheduler(): Scheduler -createScheduler() is a factory function to create a scheduler, a scheduler manage a job queue and workers to enable multiple workers to work together, it is useful when you want to speed up your performance. +createScheduler() is a factory function to create a scheduler, a scheduler manages a job queue and workers to enable multiple workers to work together, it is useful when you want to speed up your performance. **Examples:** @@ -354,7 +350,7 @@ const scheduler = createScheduler(); <a name="scheduler-add-worker"></a> ### Scheduler.addWorker(worker): string -Scheduler.addWorker() adds a worker into the worker pool inside scheduler, it is suggested to add one worker to only one sheduler. +Scheduler.addWorker() adds a worker into the worker pool inside scheduler, it is suggested to add one worker to only one scheduler. **Arguments:** |