Add example

Author: DrewImm

example/fibonacci.ts

@@ -0,0 +1,15 @@
+export function fibonacci(num: number): number {
+	if (num <= 1) {
+		return num;
+	}
+
+	return fibonacci(num - 1) + fibonacci(num - 2);
+}
+
+export function timeFibonacci(num: number): number {
+	const start = Date.now();
+
+	fibonacci(num);
+
+	return Date.now() - start;
+}

example/index.js

@@ -0,0 +1,10 @@
+/**
+ * This file boots the worker in dev when the project is run through ts-node.
+ *  - This file is not included in the build.
+ */
+if (!process.execArgv.includes('ts-node/register')) {
+    require('ts-node').register();
+}
+
+const path = require('path');
+require(path.resolve(__dirname, './index.ts'));

example/index.ts

@@ -0,0 +1,33 @@
+import { timeFibonacci } from './fibonacci';
+import { log } from './log';
+import { fibonacciQueue } from './queue';
+
+if (fibonacciQueue.isMainThread()) {
+	log.info('Starting main thread...');
+
+	const n = 30;
+
+	// Run a single fib on the main thread as a control
+	log.info('main thread took', timeFibonacci(n));
+
+	const start = Date.now();
+
+	const p1 = fibonacciQueue.await(n)
+		.then((res: number) => log.info('First worker complete in (ms)', res))
+		.catch(log.error);
+
+	const p2 = fibonacciQueue.await(n)
+		.then((res: number) => log.info('Second worker complete in (ms)', res))
+		.catch(log.error);
+
+	const p3 = fibonacciQueue.await(n)
+		.then((res: number) => log.info('Third worker complete in (ms)', res))
+		.catch(log.error);
+
+	Promise.all([p1, p2, p3])
+		.then(() => {
+			const time = Date.now() - start;
+			log.info('All took (ms) ' + time);
+		})
+		.catch(log.error);
+}

example/log.ts

@@ -0,0 +1,3 @@
+import { Log } from 'ts-tiny-log';
+
+export const log = new Log();

example/queue.ts

@@ -0,0 +1,13 @@
+import { Queue } from '../src';
+import { log } from './log';
+import { timeFibonacci } from './fibonacci';
+
+/**
+ * Worker threads
+ */
+export const fibonacciQueue = new Queue<number, number>({
+	name: 'fibonacci',
+	workerEntry: __dirname,
+	nWorkers: 4,
+	callback: async (num) => timeFibonacci(num),
+});

tsconfig.json

@@ -18,6 +18,7 @@
 		"./dist/"
 	],
 	"include": [
+		"./example/",
 		"./script/",
 		"./src/",
 		"./test/",