Merge pull request #2 from koyopro/feature/terminate_all_workers

rename: terminateAllThreads -> terminateAllWorkers

README.md

@@ -92,13 +92,13 @@ worker.once('error', (error) => {
 });
 ```
 
-### Terminating All Threads
-By calling `terminateAllThreads()`, you can terminate all worker threads that have been started with `launch()`. The return value is an array of exit codes.
+### Terminating All Worker Threads
+By calling `terminateAllWorkers()`, you can terminate all worker threads that have been started with `launch()`. The return value is an array of exit codes.
 
 ```typescript
-import { terminateAllThreads } from "sync-actions";
+import { terminateAllWorkers } from "sync-actions";
 
-const exitCodes = await terminateAllThreads();
+const exitCodes = await terminateAllWorkers();
 ```
 
 ## Environment Variables

src/index.ts

@@ -84,7 +84,7 @@ export const defineSyncWorker = <F extends Actions>(filepath: string, actions: F
  *
  * @returns A Promise that resolves to an array of exit codes for each worker.
  */
-export const terminateAllThreads = async (): Promise<(number | undefined)[]> =>
+export const terminateAllWorkers = async (): Promise<(number | undefined)[]> =>
   Promise.all(workers.map((worker) => worker.terminate()));
 
 const makeTmpFilePath = (filename: string) => {

tests/multi.test.ts

@@ -1,4 +1,4 @@
-import { terminateAllThreads } from "../src";
+import { terminateAllWorkers } from "../src";
 import actions from "./worker";
 
 
@@ -12,13 +12,13 @@ test("launch multiple workers", async () => {
   client2.worker.terminate();
 });
 
-test("terminateAllThreads()", async () => {
+test("terminateAllWorkers()", async () => {
   const client1 = actions.launch();
   const client2 = actions.launch();
   const client3 = actions.launch();
   expect(await client3.worker.terminate()).toBe(0)
 
-  await terminateAllThreads();
+  await terminateAllWorkers();
 
   // all threads are already terminated
   expect(await client1.worker.terminate()).toBeUndefined();