while2 1.0.0

package/README.md

@@ -0,0 +1,71 @@
+# While2
+
+### What is while2
+While2 is while statements, but different syntax. Also it includes a built-in index value.
+
+```javascript
+const w2 = require('./lib/while2')
+
+new w2(true)
+  .do((i, breakLoop) => {
+    if (i > 3) breakLoop() // prints 0, 1, 2, 3 then stops
+    console.log(i)
+  })
+  .end()
+```
+### Installation
+
+```npm install while2```
+
+```javascript
+const w2 = require('while2')
+```
+
+### Syntax
+
+To use while2, first import the module. It is recommended to call it "w2".
+
+```javascript
+const w2 = require('while2')
+```
+
+For every while2 statement, you will create a new instance of w2, as it is a class, and pass a condition, and for everything that you want to run while the condition is true, put .do() and then pass in a function in the parentheses. Always type .end() at the end to run the while loop in the background.
+
+```javascript
+const w2 = require('while2')
+
+new w2(true)
+  .do(() => {
+    // anything here will run again and again forever
+  })
+  .end() // this line makes sure that the while loop is ran in the background. if you don't include this nothing will happen
+```
+
+### Features: Builtin Index
+
+While2 includes an i parameter that will automatically increment every time the do function is run.
+
+```javascript
+const w2 = require('while2')
+
+new w2(true)
+  .do(i => {
+    console.log(i) /* will print 1 2 3 4 5 6 7... */
+  })
+  .end()
+```
+
+### Features: BreakLoop Function
+
+While2 includes a breakLoop parameter function so that you can break your while loop.
+
+```javascript
+const w2 = require('./lib/while2')
+
+new w2(true)
+  .do((i, breakLoop) => {
+    if (i > 3) breakLoop() // prints 0, 1, 2, 3 then stops
+    console.log(i)
+  })
+  .end()
+```

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/while2')

package/lib/while2.js

@@ -0,0 +1,32 @@
+const breakError = {}
+
+class w2 {
+  constructor(condition) {
+    if (!this instanceof w2) return new w2()
+    this.condition = condition
+    this.i = 0
+    return this
+  }
+  do(cb) {
+    this.doHandler = cb
+    return this
+  }
+  end() {
+    try {
+      while (this.condition) {
+        this.doHandler(this.i, () => {
+          throw breakError
+        }) // pass in the function to break the loop
+        this.i += 1
+      }
+    } catch(err) {
+      if (err === breakError) return
+
+      throw err
+    }
+  }
+}
+
+
+
+module.exports = w2

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "while2",
+  "version": "1.0.0",
+  "description": "for when while loops aren't verbose enoughs",
+  "main": "index.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "me",
+  "license": "UNLICENSED"
+}

package/test.js

@@ -0,0 +1,7 @@
+const w2 = require('./lib/while2')
+new w2(true)
+  .do((i, breakLoop) => {
+    if (i > 3) breakLoop()
+    console.log(i)
+  })
+  .end()