anothersequencer - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "anothersequencer",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Simple script tree sequencer in javascript. Allows creating fairly complex trees of sync/async functions or requestAnimationFrame functions with optional delays, as well as subscribing to particular outputs in the tree at any time.",
@@ -5,0 +5,0 @@ "main": "sequencer.js",

README.md

@@ -8,4 +8,5 @@ ## Javascript function sequencing
 Usage:
-```
-import {Sequencer} from 'anothersequencer'
+
+```js
+import {Sequencer} from 'anothersequencer' //or copy the html
 //import {Sequencer} from './Sequencer.js'
@@ -18,56 +19,45 @@ //in HTML: <script type='module' src='./Sequencer.js></script>
 
-//simple
-let sequence1 = [
-    (input){console.log('1'); return 2;},
-    (input){console.log(input); return 3;}, //should log "2"
-    (input) => {console.log(input)} //yeah whatever
+//simple sequences will pass the previous result along in the order of the array
+let sequence1 = [ 
+    (input)=>{console.log('a',input); return 1;},
+    (input)=>{console.log('a',input); return 2;}, //should log 1
+    async (input) => {console.log('a',input); return 3;} //should log 2
 ];
 
+sequencer.addSequence('a',sequence1);
+
+sequencer.runSequence('a', 0); //these run async
+
 //complex
-let sequence2 = [{
-    tag:'begin',
-    operation:(input)=>{}, //the callback
-    next:[{
-        delay:100, //milisecond delay before this operation is called
-        operation:(input)=>{}, //next callback
-        next:[ //functions on the next layer receive the previous layer's input and not each other's sequential input unlike the simpler sequence
-            {
-                tag:'anotheroperation', //tags let you subscribe to these results
-                delay:100,
-                operation:async (input)=>{}, //etc
-            }, 
-            {
-                operation:async (input)=>{},
-                frame:true, //uses requestAnimationFrame which is a special async function for frame and context-limited calls
-                next:'anothersequence' //can set 
-            }
-        ]
-    }]
-}];
-
-let sequence3 = { //can use objects for sequences instad of arrays
-    tag:'a',
-    operation:(input)=>{}, //the callback
-    next:{ //objects instead of arrays
-        tag:'b',
-        operation:(input)=>{},
-        next:[{
-            tag:'c',
-            operation:(input)=>{},
-            next:(prev) => {} //could set a function as the final .next operation
+let sequence2 = { //create a sequence object or array, can mix and match for each layer as well
+    operation:(input)=>{
+        console.log('b',input);
+        return 5;
+    },
+    next:[ //Calls here receive the parent result.
+        {
+            operation:(input)=>{
+                console.log('b',input);
+                return 6;
+            },
+            frame:true // can execute with requestAnimationFrame
+            next:async (input)=>{console.log('b',input);} //can end with a function
+        },
+        {
+            delay:1000, //ms delay for this call
+            operation:(input)=>{
+                console.log('b',input);
+                return 7;
+            },
+            next:'a' //or can end with another sequence tag
         }
-        ///,{...}
-      ]
-    }
+    ]
 }
 
-let onResult = (input) => {
-    console.log(input);
-}
+sequencer.addSequence('b',sequence2);
 
-sequencer.addSequence('test1',sequence1);
-sequencer.addSequence('test2',sequence2);
-sequencer.addSequence('test3',sequence3);
+sequencer.runSequence('b',4);
+```
 
-sequencer.runSequence('test1'); //can also tell it what layer to run from if there are multiple
+```js
 
@@ -83,3 +73,3 @@ let sub = sequencer.subscribeToOperation('anotheroperation',onResult); //adds a triggered function on result
 
-```
+```js
 sequencer.getSequence(
@@ -90,3 +80,3 @@ name,
 ```
-```
+```js
 sequencer.appendSequence(
@@ -103,3 +93,3 @@ name, //name of sequence
 ```
-```
+```js
 sequencer.removeSequence(
@@ -111,6 +101,6 @@ name,
 ```
-```
+```js
 //this is used recursively by runSequence otherwise to iterate a layer
 sequencer.runSequenceLayer(
-    layer=[],
+    layer,
     previousResult
@@ -117,0 +107,0 @@ )

Sequencer.js

@@ -69,6 +69,10 @@ //Simple script sequencer
                 if (triggers){
-                    let obj = triggers.find((o)=>{
-                        if(o.idx===sub) {return true;}
-                    });
-                    if(obj) triggers.splice(idx,1);
+                    if(!sub) delete this.triggers[key];
+                    else {
+                        let obj = triggers.find((o)=>{
+                            if(o.idx===sub) {return true;}
+                        });
+                        if(obj) triggers.splice(idx,1);
+                        return true;
+                    }
                 }
@@ -75,0 +79,0 @@ },

No alert changes

Improved metrics

Lines of code

224

increased by1.82%

Worsened metrics

Total package byte prevSize

58114

decreased by-0.48%

Number of lines in readme file

104

decreased by-8.77%

No dependency changes