✨ TypeScript 2.3 RC

📚 example with Async generators & iterators

Author: xmlking

README.md

@@ -39,6 +39,37 @@ import  {Banner, Gauge, Spinner, Sparkline, Progress, Line, LineBuffer} from 'no
 })();
 ```
 
+```ts
+async function* getProgressSlowly() {
+    let progress = 0;
+
+    while (progress <= 100) {
+        await sleep(50);
+        progress += Math.round(Math.random() * 5);
+        if (progress >= 100) {
+            yield 100;
+        } else {
+            yield progress;
+        }
+    }
+}
+
+async function startDownload() {
+    let myProgress = new Progress(50, chalk.green('Finished download!'));
+
+    for await (let progress of getProgressSlowly()) {
+        myProgress.update(progress, 100)
+    }
+}
+
+(async () => {
+    console.log('Starting downloads...');
+    for (let i = 0; i < 10; i ++) {
+        startDownload()
+    }
+})();
+```
+
 ## Developer Setup
 
 ### Setup
@@ -52,7 +83,8 @@ yarn run build
 ```
 ### Examples
 ```bash
-ts-node examples.js
+# ts-node examples.js
+ts-node --disableWarnings  examples.ts
 ```
 
 ### Test
@@ -65,4 +97,4 @@ yarn run test
 yarn run prepublishOnly
 cd dist
 npm publish
-```
+```

examples.js renamed to examples.ts

@@ -1,15 +1,19 @@
+require('core-js/es7/symbol.js');
 import * as chalk from 'chalk';
 import * as os  from 'os';
 import  {Banner, Gauge, Spinner, Sparkline, Progress, Line, LineBuffer} from './src/index'
 require('draftlog').into(console);
 
+export function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
 
 /********************/
 
-var total = os.totalmem();
-var free = os.freemem();
-var used = total - free;
-var human = Math.ceil(used / 1000000) + ' MB';
+const total = os.totalmem();
+const free = os.freemem();
+const used = total - free;
+const human = Math.ceil(used / 1000000) + ' MB';
 console.log('' + new Gauge(used, total, 20, total * 0.8, chalk.bold.grey(human)));
 
 /********************/
@@ -74,7 +78,7 @@ const header = new Line(outputBuffer)
     .store();
 
 let line;
-for(var l = 0; l < 20; l++)
+for(let l = 0; l < 20; l++)
 {
     line = new Line(outputBuffer)
         .column((Math.random()*100).toFixed(3), 20)
@@ -87,53 +91,60 @@ for(var l = 0; l < 20; l++)
 
 outputBuffer.output();
 
-
-/********************/
-
-const countdown = new Spinner('Exiting in 10 seconds...  ');
-
-countdown.start(chalk.bgYellow.blue);
-
-let number = 10;
-setInterval(function () {
-    number--;
-    countdown.message = 'Exiting in ' + number + ' seconds...  ';
-    if (number === 0) {
-        process.stdout.write('\n');
-        process.exit(0);
-    }
-}, 1000);
-
-
 /********************/
 
 const banner = new Banner('  Node UI is Awesome!    See what you can build with this module   ');
 
 /********************/
 
+async function* getProgressSlowly() {
+    let progress = 0;
 
-function startDownload() {
-    let progress = 0
+    while (progress <= 100) {
+        await sleep(50);
+        progress += Math.round(Math.random() * 5);
+        if (progress >= 100) {
+            yield 100;
+        } else {
+            yield progress;
+        }
+    }
+}
+
+async function startDownload() {
+    // let progress = 0;
     // let myProgress = new Progress();
     // let myProgress = new Progress(50, chalk.green('Finished download!'), chalk.red('|'), '-');
     let myProgress = new Progress(50, chalk.green('Finished download!'));
-    let interval = setInterval( () => {
-        progress += Math.round(Math.random() * 5)
-        if(progress > 100) {
-            myProgress.update(100, 100)
-            clearInterval(interval)
-        } else {
-            myProgress.update(progress, 100)
-        }
-    }, 50)
+
+    for await (let progress of getProgressSlowly()) {
+        myProgress.update(progress, 100)
+    }
 }
 
 (async () => {
-    console.log('Starting downloads...')
+    console.log('Starting downloads...');
     for (let i = 0; i < 10; i ++) {
         startDownload()
         // await sleep(100)
     }
 })();
 
+
+/********************/
+
+const countdown = new Spinner('Exiting in 10 seconds...  ');
+
+countdown.start(chalk.bgYellow.blue);
+
+let number = 20;
+setInterval(function () {
+    number--;
+    countdown.message = 'Exiting in ' + number + ' seconds...  ';
+    if (number === 0) {
+        process.stdout.write('\n');
+        process.exit(0);
+    }
+}, 1000);
+
 /********************/

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodeui",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Command Line UI components for Node.js",
   "keywords": [
     "UI",
@@ -27,7 +27,7 @@
   "license": "MIT",
   "scripts": {
     "prebuild": "node tools/delete.js",
-    "build": "tsc --p src/tsconfig.app.json && tsc --p src/tsconfig.esm.json",
+    "build": "tsc --p src/tsconfig.app.json --lib esnext && tsc --p src/tsconfig.esm.json --lib esnext",
     "prepublishOnly": "yarn run build && node tools/copy.js",
     "test": "ts-node test.ts"
   },
@@ -39,8 +39,10 @@
     "@types/chalk": "^0.4.31",
     "@types/jasmine": "^2.5.47",
     "@types/node": "^7.0.12",
+    "core-js": "^2.4.1",
     "fs-p": "^2.0.0",
     "jasmine": "^2.5.3",
-    "jasmine-spec-reporter": "^3.2.0"
+    "jasmine-spec-reporter": "^4.0.0",
+    "typescript": "^2.3.0"
   }
 }

src/line.ts

@@ -3,12 +3,12 @@ import * as chalk from "chalk";
 export class Line {
     private lineContent = "";
 
-    constructor(public defaultBuffer) {
+    constructor(public defaultBuffer?) {
     }
 
 
     // Put text in the line
-    text(text, styles) {
+    text(text, styles?) {
         if(styles) {
             styles.forEach(function (element) {
                 text = element(text);
@@ -19,7 +19,7 @@ export class Line {
     };
 
     // Put padding in the line.
-    padding(width, styles) {
+    padding(width, styles?) {
         let padding = Array(width + 1).join(" ");
         if(styles) {
             styles.forEach(function (element) {
@@ -31,7 +31,7 @@ export class Line {
     };
 
     // Put padding in the line.
-    column(text, columnWidth, textStyles) {
+    column(text, columnWidth, textStyles?) {
         let textWidth = chalk.stripColor(text).length;
 
         if (textWidth > columnWidth) {
@@ -48,15 +48,15 @@ export class Line {
     }
 
     // Fill the rest of the width of the line with space.
-    fill(styles) {
+    fill(styles?) {
         let fillWidth = process.stdout.columns - chalk.stripColor(this.lineContent).length;
         if (fillWidth > 0)
             this.padding(fillWidth, styles);
         return this;
     }
 
     // Store a line in a line buffer to be output later.
-    store(buffer) {
+    store(buffer?) {
         if (typeof buffer == 'undefined') {
             if (typeof this.defaultBuffer == 'undefined')
                 process.stderr.write('Attempt to store a line in a line buffer, without providing a line buffer to store that line in.');

src/tsconfig.app.json

@@ -7,6 +7,7 @@
     "allowJs": false
   },
   "exclude": [
-    "**/*.spec.ts"
+    "**/*.spec.ts",
+    "../examples.ts"
   ]
 }

src/tsconfig.esm.json

@@ -7,6 +7,7 @@
     "allowJs": false
   },
   "exclude": [
-    "**/*.spec.ts"
+    "**/*.spec.ts",
+    "../examples.ts"
   ]
 }

test.ts

@@ -5,7 +5,7 @@ import SuiteInfo = jasmine.SuiteInfo;
 
 
 class CustomProcessor extends DisplayProcessor {
-    public displayJasmineStarted(info: SuiteInfo, log: String): String {
+    public displayJasmineStarted(info: SuiteInfo, log: string): string {
         return `TypeScript ${log}`;
     }
 }

tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "module": "commonjs",
-    "target": "ESNext",
+    "target": "es2015",
     "noImplicitAny": false,
     "sourceMap": true,
     "allowJs": true,
@@ -11,10 +11,11 @@
     "outDir": "dist"
   },
   "lib" : [
-    "ESNext"
+    "esnext"
   ],
   "include": [
-    "src/**/*.ts"
+    "src/**/*.ts",
+    "examples.ts"
   ],
   "exclude": [
     "dist",