Merge pull request #23 from mixmaxhq/adborroto/PG-62/typescriptify

adborroto/PG 62 convert to typescript

.eslintrc.json

@@ -1,3 +1,6 @@
 {
-  "extends": ["mixmax/node", "mixmax/prettier"]
+    "extends": [
+        "mixmax/node",
+        "mixmax/prettier"
+    ]
 }

.github/workflows/ci.yml

@@ -0,0 +1,13 @@
+name: continuous-integration
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  checks:
+    uses: mixmaxhq/github-workflows-public/.github/workflows/checks.yml@main

.gitignore

@@ -24,4 +24,4 @@ node_modules
 .node_repl_history
 .DS_Store
 *.sublime-workspace
-/dist
+/dist

.nvmrc

@@ -0,0 +1 @@
+18.20.0

README.md

@@ -1,5 +1,4 @@
-promise-pool
-============
+# promise-pool
 
 Concurrent control of async function invocation with a pool-like abstraction. Implicitly applies
 backpressure to the imperative task producer.
@@ -11,11 +10,11 @@ import PromisePool from '@mixmaxhq/promise-pool';
 
 async function sample() {
   // Cap the concurrent function execution at 10.
-  const pool = new PromisePool({numConcurrent: 10});
+  const pool = new PromisePool({ numConcurrent: 10 });
 
   // Call an async function 1000000 times. The pool ensures that no more than
   // 10 will be executing at a time.
-  for (let i = 0; i < 1000000; ++i) {
+  for (const i = 0; i < 1000000; ++i) {
     // The await suspends the for loop until the function has started.
     await pool.start(async (i) => {
       await sendResult(await getResult(i));
@@ -46,8 +45,7 @@ has built-in backpressure, to simplify writing concurrent code that avoids loadi
 memory. This module is a rewrite of the [synchronize-pool][] module, but instead of using
 synchronize, it uses async/await.
 
-Install
--------
+## Install
 
 We're hoping to use the `promise-pool` package name, but it's currently occupied.
 
@@ -61,19 +59,19 @@ or
 $ npm i @mixmaxhq/promise-pool
 ```
 
-Changelog
----------
+## Changelog
 
-* 2.0.0 Add `maxPending` option to avoid problematic usage (see new [Troubleshooting](#troubleshooting) section)
+- 3.0.0 Migrate codebase to TypeScript for improved type safety and developer experience.
 
-* 1.1.1 Move `ava` and `ava-spec` to `devDependencies`.
+- 2.0.0 Add `maxPending` option to avoid problematic usage (see new [Troubleshooting](#troubleshooting) section)
 
-* 1.1.0 Adds transpilation so it can be used in Node 6 (and prior) environments.
+- 1.1.1 Move `ava` and `ava-spec` to `devDependencies`.
 
-* 1.0.0 Initial release.
+- 1.1.0 Adds transpilation so it can be used in Node 6 (and prior) environments.
 
-Troubleshooting
----------------
+- 1.0.0 Initial release.
+
+## Troubleshooting
 
 ### `cannot queue function in pool`
 
@@ -117,7 +115,7 @@ Instead, you need to use some iteration method that preserves backpressure, like
 
 ```js
 async function startJobs() {
-  const pool = new PromisePool({numConcurrent: 4});
+  const pool = new PromisePool({ numConcurrent: 4 });
 
   // Still severely suboptimal.
   const users = await db.users.findAsCursor().toArray();
@@ -140,7 +138,7 @@ Or even better, couple this with a call to `promise-iterate` to only load users
 import promiseIterate from 'promise-iterate';
 
 async function startJobs() {
-  const pool = new PromisePool({numConcurrent: 4});
+  const pool = new PromisePool({ numConcurrent: 4 });
 
   const users = await db.users.findAsCursor();
 
@@ -202,8 +200,7 @@ async function sendEmails(pool, users) {
 }
 ```
 
-License
--------
+## License
 
 > The MIT License (MIT)
 >

jest.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+  preset: 'ts-jest',
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'js', 'json', 'node'],
+  clearMocks: true,
+  collectCoverageFrom: ['src/**/*.js'],
+  coverageDirectory: 'coverage',
+  testRegex: '/((test|spec)s?|src)/.*([Tt]est|[Ss]pec)\\.(ts|js)$',
+  testEnvironment: 'node',
+  moduleNameMapper: {
+    '^mongodbMapped$': `mongodb${process.env.DRIVER_VERSION || ''}`,
+  },
+  testTimeout: 15000,
+};