optimize code

deno-library · Jan 5, 2024 · 2b42daa · 2b42daa
1 parent 68c30d4
commit 2b42daa
Show file tree

Hide file tree

Showing 22 changed files with 56 additions and 60 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@ ProgressBar in terminal for deno
 
 ```ts
 import { MultiProgressBar } from "https://deno.land/x/[email protected]/mod.ts";
+export { delay } from "https://deno.land/[email protected]/async/delay.ts";
 
 const title = "download files";
 const total = 100;
@@ -27,29 +28,26 @@ const bars = new MultiProgressBar({
 let completed1 = 0;
 let completed2 = 0;
 
-function downloading() {
-  if (completed1 <= total || completed2 <= total) {
+async function download() {
+  while (completed1 <= total || completed2 <= total) {
     completed1 += 1;
     completed2 += 2;
-    bars.render([
+    await bars.render([
       {
         completed: completed1,
         total,
         text: "file1",
-        // You can also change the style of the progress bar
-        // complete: "*",
-        // incomplete: ".",
+        complete: "*",
+        incomplete: ".",
       },
       { completed: completed2, total, text: "file2" },
     ]);
 
-    setTimeout(function () {
-      downloading();
-    }, 100);
+    await delay(50);
   }
 }
 
-downloading();
+await download();
 ```
 
 #### interface
@@ -149,6 +147,7 @@ What is displayed and display order, default: ':bar :text :percent :time
 
 ```ts
 import ProgressBar from "https://deno.land/x/[email protected]/mod.ts";
+export { delay } from "https://deno.land/[email protected]/async/delay.ts";
 
 const title = "downloading:";
 const total = 100;
@@ -157,22 +156,21 @@ const progress = new ProgressBar({
   total,
 });
 let completed = 0;
-function downloading() {
-  if (completed <= total) {
-    progress.render(completed++);
+async function download() {
+  while (completed <= total) {
+    await progress.render(completed++);
 
-    setTimeout(function () {
-      downloading();
-    }, 100);
+    await delay(50);
   }
 }
-downloading();
+await download();
 ```
 
 #### complex example
 
 ```ts
 import ProgressBar from "https://deno.land/x/[email protected]/mod.ts";
+export { delay } from "https://deno.land/[email protected]/async/delay.ts";
 
 const total = 100;
 const progress = new ProgressBar({
@@ -188,16 +186,14 @@ const progress = new ProgressBar({
   // ...
 });
 let completed = 0;
-function run() {
-  if (completed <= total) {
-    progress.render(completed++);
+async function download() {
+  while (completed <= total) {
+    await progress.render(completed++);
 
-    setTimeout(function () {
-      run();
-    }, 100);
+    await delay(50);
   }
 }
-run();
+await download();
 ```
 
 More examples in the `examples` folder.

diff --git a/deps_dev.ts → deps_test.ts b/deps_dev.ts → deps_test.ts
diff --git a/examples/backward.ts b/examples/backward.ts
@@ -19,7 +19,7 @@ async function forward() {
 async function backward() {
   while (completed > 0) {
     // ==> here
-    progress.render(--completed);
+    await progress.render(--completed);
     // <== here
     await delay(20);
   }

diff --git a/examples/changeBgColor.ts b/examples/changeBgColor.ts
@@ -9,7 +9,7 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function run() {
+async function download() {
   while (completed <= total) {
     if (completed >= 20) {
       await progress.render(completed++, {
@@ -26,4 +26,4 @@ async function run() {
   }
 }
 
-await run();
+await download();
diff --git a/examples/changeColor.ts b/examples/changeColor.ts
@@ -11,7 +11,7 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function run() {
+async function download() {
   while (completed <= total) {
     if (completed >= 20) {
       await progress.render(completed++, {
@@ -28,4 +28,4 @@ async function run() {
   }
 }
 
-await run();
+await download();
diff --git a/examples/clear.ts b/examples/clear.ts
@@ -12,12 +12,12 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function run() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++);
 
     await delay(20);
   }
 }
 
-await run();
+await download();
diff --git a/examples/colorProgression.ts b/examples/colorProgression.ts
@@ -9,7 +9,7 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function run() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++, {
       // ==> here
@@ -21,4 +21,4 @@ async function run() {
   }
 }
 
-await run();
+await download();
diff --git a/examples/complete.ts b/examples/complete.ts
@@ -13,12 +13,12 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function run() {
+async function download() {
   while (completed <= total) {
     progress.render(completed++);
 
     await delay(20);
   }
 }
 
-await run();
+await download();
diff --git a/examples/console.ts b/examples/console.ts
@@ -11,7 +11,7 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function downloading() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++);
 
@@ -23,4 +23,4 @@ async function downloading() {
   }
 }
 
-await downloading();
+await download();
diff --git a/examples/display.ts b/examples/display.ts
@@ -18,12 +18,12 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function run() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++);
 
     await delay(20);
   }
 }
 
-await run();
+await download();
diff --git a/examples/eta.ts b/examples/eta.ts
@@ -14,12 +14,12 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function run() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++);
 
     await delay(20);
   }
 }
 
-await run();
+await download();
diff --git a/examples/info.ts b/examples/info.ts
@@ -22,7 +22,7 @@ function* log() {
 
 const info = log();
 
-async function run() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++, {
       title: completed % 20 === 0 ? info.next().value + "" : "",
@@ -32,4 +32,4 @@ async function run() {
   }
 }
 
-await run();
+await download();
diff --git a/examples/multi.ts b/examples/multi.ts
@@ -15,7 +15,7 @@ const bars = new MultiProgressBar({
 let completed1 = 0;
 let completed2 = 0;
 
-async function downloading() {
+async function download() {
   while (completed1 <= total || completed2 <= total) {
     completed1 += 1;
     completed2 += 2;
@@ -34,4 +34,4 @@ async function downloading() {
   }
 }
 
-await downloading();
+await download();
diff --git a/examples/multiPrettyTime.ts b/examples/multiPrettyTime.ts
@@ -16,7 +16,7 @@ const bars = new MultiProgressBar({
 let completed1 = 0;
 let completed2 = 0;
 
-async function downloading() {
+async function download() {
   if (completed1 <= total || completed2 <= total) {
     completed1 += 1;
     completed2 += 2;
@@ -49,4 +49,4 @@ async function downloading() {
   }
 }
 
-await downloading();
+await download();
diff --git a/examples/preciseBar.ts b/examples/preciseBar.ts
@@ -21,12 +21,12 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function downloading() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++);
 
     await delay(50);
   }
 }
 
-await downloading();
+await download();
diff --git a/examples/prettyTime.ts b/examples/prettyTime.ts
@@ -15,7 +15,7 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function run() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++, {
       prettyTimeOptions: {
@@ -29,4 +29,4 @@ async function run() {
   }
 }
 
-await run();
+await download();
diff --git a/examples/title.ts b/examples/title.ts
@@ -13,12 +13,12 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function downloading() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++);
 
     await delay(50);
   }
 }
 
-await downloading();
+await download();
diff --git a/examples/total.ts b/examples/total.ts
@@ -12,7 +12,7 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function downloading() {
+async function download() {
   while (completed <= total) {
     // Can also be set in the constructor
     // ==> here
@@ -23,4 +23,4 @@ async function downloading() {
   }
 }
 
-await downloading();
+await download();
diff --git a/examples/width.ts b/examples/width.ts
@@ -15,12 +15,12 @@ const progress = new ProgressBar({
 
 let completed = 0;
 
-async function downloading() {
+async function download() {
   while (completed <= total) {
     await progress.render(completed++);
 
     await delay(20);
   }
 }
 
-await downloading();
+await download();
diff --git a/tests/mod.test.ts b/tests/mod.test.ts
@@ -1,5 +1,5 @@
 import ProgressBar from "../mod.ts";
-import { simpleTimerStream } from "../deps_dev.ts";
+import { simpleTimerStream } from "../deps_test.ts";
 
 Deno.test(`Use ProgressBar in a deno test`, async () => {
   const progress = new ProgressBar({ title: "downloading: ", total: 50 });

diff --git a/tests/multi.test.ts b/tests/multi.test.ts
@@ -1,5 +1,5 @@
 import { MultiProgressBar } from "../mod.ts";
-import { delay } from "../deps_dev.ts";
+import { delay } from "../deps_test.ts";
 
 Deno.test(`Use MultiProgressBar in a deno test`, async () => {
   const title = "download files";

diff --git a/tests/time.test.ts b/tests/time.test.ts
@@ -1,5 +1,5 @@
 import { prettyTime } from "../time.ts";
-import { assertEquals } from "../deps_dev.ts";
+import { assertEquals } from "../deps_test.ts";
 
 Deno.test(`test prettyTime: default`, () => {
   // assertEquals(prettyTime(10), "10.0s");