Merge pull request #122 from ashish-r/fix/kill-worker

Fix kill functionality
alewin · Dec 11, 2022 · 19d2f24 · 19d2f24
2 parents 1ceb211 + 638859f
commit 19d2f24
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 14 deletions.
diff --git a/packages/useWorker/src/lib/status.ts b/packages/useWorker/src/lib/status.ts
@@ -4,6 +4,7 @@ export enum WORKER_STATUS {
   RUNNING = 'RUNNING',
   ERROR = 'ERROR',
   TIMEOUT_EXPIRED = 'TIMEOUT_EXPIRED',
+  KILLED = 'KILLED',
 }
 
 export default WORKER_STATUS
diff --git a/packages/useWorker/src/useWorker.ts b/packages/useWorker/src/useWorker.ts
@@ -40,7 +40,7 @@ const DEFAULT_OPTIONS: Options = {
 export const useWorker = <T extends (...fnArgs: any[]) => any>(
   fn: T, options: Options = DEFAULT_OPTIONS,
 ) => {
-  const [workerStatus, _setWorkerStatus] = React.useState<WORKER_STATUS>(WORKER_STATUS.PENDING)
+  const [workerStatus, setWorkerStatus] = React.useState<WORKER_STATUS>(WORKER_STATUS.PENDING)
   const worker = React.useRef<Worker & { _url?: string }>()
   const isRunning = React.useRef(false)
   const promise = React.useRef<{
@@ -49,11 +49,6 @@ export const useWorker = <T extends (...fnArgs: any[]) => any>(
   }>({})
   const timeoutId = React.useRef<number>()
 
-  const setWorkerStatus = React.useCallback((status: WORKER_STATUS) => {
-    isRunning.current = status === WORKER_STATUS.RUNNING
-    _setWorkerStatus(status)
-  }, [])
-
   const killWorker = React.useCallback(() => {
     if (worker.current?._url) {
       worker.current.terminate()
@@ -156,11 +151,20 @@ export const useWorker = <T extends (...fnArgs: any[]) => any>(
     return callWorker(...fnArgs)
   }, [options.autoTerminate, generateWorker, callWorker])
 
+  const killWorkerController = React.useCallback(() => {
+    killWorker()
+    setWorkerStatus(WORKER_STATUS.KILLED)
+  }, [killWorker, setWorkerStatus])
+
   const workerController = {
     status: workerStatus,
-    kill: killWorker,
+    kill: killWorkerController,
   }
 
+  React.useEffect(() => {
+    isRunning.current = workerStatus === WORKER_STATUS.RUNNING
+  }, [workerStatus])
+
   React.useEffect(() => () => {
     killWorker()
   }, [killWorker])

diff --git a/packages/website/docs/workerstatus.md b/packages/website/docs/workerstatus.md
@@ -11,10 +11,11 @@ import { WORKER_STATUS } from "@koale/useworker";
 
 ## API
 
-| WORKER_STATUS     | Type   | Description                                                        |
-| ----------------- | ------ | ------------------------------------------------------------------ |
-| `PENDING`         | string | the web worker has been initialized, but has not yet been executed |
-| `SUCCESS`         | string | the web worker, has been executed correctly                        |
-| `RUNNING`         | string | the web worker, is running                                         |
-| `ERROR`           | string | the web worker, ended with an error                                |
-| `TIMEOUT_EXPIRED` | string | The web worker was killed because the defined timeout expired.     |
+| WORKER_STATUS     | Type   | Description                                                                      |
+| ----------------- | ------ | ---------------------------------------------------------------------------------|
+| `PENDING`         | string | the web worker has been initialized, but has not yet been executed               |
+| `SUCCESS`         | string | the web worker, has been executed correctly                                      |
+| `RUNNING`         | string | the web worker, is running                                                       |
+| `ERROR`           | string | the web worker, ended with an error                                              |
+| `TIMEOUT_EXPIRED` | string | The web worker was killed because the defined timeout expired                    |
+| `KILLED`          | string | The web worker was killed by the [kill](./useworker.md#controller-api) function  |