Legacy (#17)

* parking

* typescript fixed

* linting fixed

* tests fixed

* update tests

* docs

* docs

Author: vitaly-t

README.md

@@ -20,17 +20,12 @@ $ npm i spex
 
 ## Usage
 
-* For any [Promises/A+] library: [Promise], [Bluebird], [When], [Q], [RSVP], etc.
+```ts
+import {batch, errors} from 'spex';
 
-```js
-const promise = require('bluebird');
-const spex = require('spex')(promise);
-```
-
-* For ES6 Promise:
-
-```js
-const spex = require('spex')(Promise);
+await batch([1, 2, 3])
+    .catch((err: errors.BatchError) => {
+    });
 ```
 
 See also: [client-side usage](http://vitaly-t.github.io/spex/tutorial-client.html).

eslint.config.js

@@ -1,5 +1,5 @@
-const js = require("@eslint/js");
-const globals = require("globals");
+const js = require('@eslint/js');
+const globals = require('globals');
 
 module.exports = [
     js.configs.recommended,
@@ -12,33 +12,33 @@ module.exports = [
                 ...globals.BigInt,
             },
             parserOptions: {
-                ecmaFeatures: { globalReturn: true },
+                ecmaFeatures: {globalReturn: true}
             },
-            sourceType: "commonjs",
-            ecmaVersion: 2022,
+            sourceType: 'commonjs',
+            ecmaVersion: 2020
         },
         rules: {
-            "no-var": "error",
-            "prefer-const": "error",
-            "prefer-arrow-callback": "error",
-            "no-else-return": "error",
-            "no-multi-spaces": "error",
-            "no-whitespace-before-property": "error",
-            camelcase: "error",
-            "new-cap": "error",
-            "no-console": "error",
-            "comma-dangle": "error",
-            "no-shadow": "error",
-            "object-shorthand": ["error", "properties"],
+            'no-var': 'error',
+            'prefer-const': 'error',
+            'prefer-arrow-callback': 'error',
+            'no-else-return': 'error',
+            'no-multi-spaces': 'error',
+            'no-whitespace-before-property': 'error',
+            camelcase: 'error',
+            'new-cap': 'error',
+            'no-console': 'error',
+            'comma-dangle': 'error',
+            'no-shadow': 'error',
+            'object-shorthand': ['error', 'properties'],
             indent: [
-                "error",
+                'error',
                 4,
                 {
-                    SwitchCase: 1,
-                },
+                    SwitchCase: 1
+                }
             ],
-            quotes: ["error", "single"],
-            semi: ["error", "always"],
-        },
-    },
+            quotes: ['error', 'single'],
+            semi: ['error', 'always']
+        }
+    }
 ];

jsdoc/fixLinks.js

@@ -5,11 +5,7 @@ const links = {
     'stream': 'https://github.com/vitaly-t/spex/blob/master/docs/concept/stream.md',
     'client-side': 'https://github.com/vitaly-t/spex/blob/master/docs/client.md',
     'Promise': 'https://github.com/then/promise',
-    'Bluebird': 'https://github.com/petkaantonov/bluebird',
     'When': 'https://github.com/cujojs/when',
-    'Q': 'https://github.com/kriskowal/q',
-    'RSVP': 'https://github.com/tildeio/rsvp.js',
-    'Lie': 'https://github.com/calvinmetcalf/lie',
     'Promises/A+': 'https://promisesaplus.com'
 };
 

jsdoc/jsdoc.js

@@ -1,7 +1,7 @@
 module.exports = {
     source: {
         include: [
-            'lib'
+            'src'
         ]
     },
     opts: {

jsdoc/tutorials/batch.md

@@ -29,7 +29,7 @@ And this is where method [batch] helps:
 Let's start with a positive example, and throw in a few combinations of [mixed values].
 
 ```js
-const spex = require('spex')(Promise);
+const {batch} = require('spex');
 
 // function that returns a promise;
 function getWord() {
@@ -53,7 +53,7 @@ const values = [
     Promise.resolve(nested)
 ];
 
-spex.batch(values)
+batch(values)
     .then(data => {
         console.log('DATA:', data);
     })
@@ -103,4 +103,3 @@ This is just to simplify quick access to the list of errors that occurred.
 
 [batch]:http://vitaly-t.github.io/spex/global.html#batch
 [mixed values]:http://vitaly-t.github.io/spex/tutorial-mixed.html
-

jsdoc/tutorials/client.md

@@ -16,14 +16,13 @@ $ npm install
 $ npm run browserify
 ```
 
-This generates file `spex.js` within the module's root folder, to be copied into your web project.
-
-The library exposes global variable `spexLib`, to be initialized as shown in the following example:
+This generates file `spex.js` within the module's root folder, to be copied into your web project,
+which exposes global variable `spexLib`:
 
 ```html
 <script src="spex.js"></script>
 <script>
-    const spex = spexLib(Promise); // Initializing with ES6 Promise;
+    const {batch, page, sequence, errors} = spexLib;
 </script>
 ```
 

jsdoc/tutorials/streaming.md

@@ -15,7 +15,7 @@ Below is a simple track-enabled sequence that creates and returns promises one b
 It also includes a destination function for logging purposes.
 
 ```js
-const spex = require('spex')(Promise);
+const {sequence} = require('spex');
 
 function source(index, data, delay) {
     // create and return a promise objects dynamically,
@@ -38,7 +38,7 @@ function dest(index, data, delay) {
     console.log('LOG:', index, data, delay);
 }
 
-spex.sequence(source, {dest: dest, track: true})
+sequence(source, {dest: dest, track: true})
     .then(data => {
         console.log('DATA:', data); // print result;
     });
@@ -56,7 +56,7 @@ DATA: [ 'zero', 'one', 'two', 'three' ]
 And if we run the same sequence without tracking (default):
 
 ```js
-spex.sequence(source, {dest: dest})
+sequence(source, {dest: dest})
     .then(data => {
         console.log('DATA:', data); // print result;
     });

jsdoc/tutorials/throttling.md

@@ -24,7 +24,7 @@ The example below uses method [page] to initiate a sequence of 5 pages, and then
 The `source` function serves each page with a half-second delay.
 
 ```js
-const spex = require('spex')(Promise);
+const {page} = require('spex');
 
 function source(index, data, delay) {
     return new Promise((resolve, reject) => {
@@ -41,7 +41,7 @@ function logger(index, data, delay) {
     console.log('LOG:', data);
 }
 
-spex.page(source, {dest: logger, limit: 5})
+page(source, {dest: logger, limit: 5})
     .then(data => {
         console.log('FINISHED:', data);
     });
@@ -64,7 +64,7 @@ In the following example we have a [sequence] that returns data while the index
 destination function that enforces a 1 second delay on processing each data resolved from the source.
 
 ```js 
-const spex = require('spex')(Promise);
+const {sequence} = require('spex');
 
 function source(index, data, delay) {
     console.log('SOURCE:', index, data, delay);
@@ -82,7 +82,7 @@ function dest(index, data, delay) {
     });
 }
 
-spex.sequence(source, {dest: dest})
+sequence(source, {dest: dest})
     .then(data => {
         console.log('DATA:', data);
     });