chore(docs): updating docs

Author: doublecompile

docs/examples/README.md

@@ -9,3 +9,4 @@
 ### Features
 
 - [Handling output](handling-output.md)
+- [Using the `.wrap()` method](using-wrap.md)

docs/examples/handling-output.md

@@ -7,7 +7,7 @@
 ```typescript
 import type { ChalkInstance } from "chalk";
 import type { Logger } from "ts-log";
-import { LogLevel, Output, Program } from "@libreworks/cli";
+import { Output, Program } from "@libreworks/cli";
 
 const sleep = (ms: number) => new Promise((r) => setTimeout(r, ms));
 
@@ -19,39 +19,37 @@ async function makeLogEntries(logger: Logger, colors: ChalkInstance) {
   }
 }
 
-const output = Output.create({
-  verbosity: LogLevel.TRACE,
-  color: true,
-});
+const output = Output.create({});
 
-const command = new Command("@libreworks/cli:example-handling-output")
+const program = new Program("@libreworks/cli:example-handling-output")
   .description("A test of @libreworks/cli")
-  .version("0.0.0")
-  .action(async function (options, cmd) {
-    // Send data as-is to stdout.
-    output.write("You called the handler!");
-
-    // Use the logger, which writes to stderr.
-    output.log.info("Handler invoked", { options });
-    output.log.info(`Testing ${output.colors.red("123")}`);
-
-    await Promise.all([
-      // Send logs to stderr at regular intervals.
-      makeLogEntries(output.logger, output.colors),
-
-      // Show a loading indicator for 5 seconds.
-      output.spinDuring(sleep(5000), "Reticulating Splines"),
-    ]);
-
-    output.log.warn("This is a warning!");
-
-    try {
-      throw new Error("A Big Problem");
-    } catch (e) {
-      // Stop the spinner and display the error.
-      output.fail(e);
-    }
-  });
+  .version("0.0.0");
+
+program.action(async function (options, cmd) {
+  // Send data as-is to stdout.
+  output.write("You called the handler!");
+
+  // Use the logger, which writes to stderr.
+  output.log.info("Handler invoked", { options });
+  output.log.info(`Testing ${output.colors.red("123")}`);
+
+  await Promise.all([
+    // Send logs to stderr at regular intervals.
+    makeLogEntries(output.logger, output.colors),
+
+    // Show a loading indicator for 5 seconds.
+    output.spinDuring(sleep(5000), "Reticulating Splines"),
+  ]);
+
+  output.log.warn("This is a warning!");
+
+  try {
+    throw new Error("A Big Problem");
+  } catch (e) {
+    // Stop the spinner and display the error.
+    output.fail(e);
+  }
+});
 
 await command.parseAsync();
 ```

docs/examples/using-wrap.md

@@ -0,0 +1,45 @@
+# @libreworks/cli
+
+## Examples
+
+### Using the `.wrap()` Method
+
+```typescript
+import type { ChalkInstance } from "chalk";
+import type { Logger } from "ts-log";
+import { Output, Program } from "@libreworks/cli";
+
+const sleep = (ms: number) => new Promise((r) => setTimeout(r, ms));
+
+async function makeLogEntries(logger: Logger, colors: ChalkInstance) {
+  logger.info("Time to make the entries!");
+  for (let i = 0; i < 10; i++) {
+    logger.trace(`Testing ${colors.green(i)}`);
+    await sleep(500);
+  }
+}
+
+const output = Output.create({});
+
+const program = new Program(output, "@libreworks/cli:example-handling-output")
+  .description("A test of @libreworks/cli")
+  .version("0.0.0");
+
+program.action(
+  // The loading indicator will display during this async function.
+  program.wrap(async function (options, cmd) {
+    // Use the logger, which writes to stderr.
+    output.log.info("Handler invoked", { options });
+    output.log.info(`Testing ${output.colors.red("123")}`);
+
+    // Send logs to stderr at regular intervals.
+    makeLogEntries(output.logger, output.colors);
+    output.log.warn("This is a warning!");
+
+    // Send data as-is to stdout.
+    return "You called the handler!";
+  })
+);
+
+await command.parseAsync();
+```