@optique/run 1.3.0-dev.2534 → 1.3.0-dev.2538

package/dist/print.cjs

@@ -12,6 +12,8 @@ const __optique_core_internal_terminal = require_rolldown_runtime.__toESM(requir
 *
 * @param message The structured message to print.
 * @param options Optional formatting options to override defaults.
+* @throws {TypeError} If initialWidth is not a finite integer.
+* @throws {RangeError} If initialWidth is negative or a theme color is invalid.
 *
 * @example
 * ```typescript
@@ -71,7 +73,9 @@ function printError(message, options = {}) {
 * operations or when you want to override the automatic terminal detection.
 *
 * @param options Formatting options for the printer.
-* @returns A printer function that can be called with messages.
+* @returns A printer function that can be called with messages. The returned
+* function validates initialWidth and theme colors when formatting a message
+* and can throw the exceptions documented on {@link Printer}.
 *
 * @example
 * ```typescript

package/dist/print.d.cts

@@ -52,6 +52,8 @@ interface PrinterOptions extends MessageFormatOptions {
 /**
  * A printer function that outputs formatted messages.
  * @param message The structured message to print.
+ * @throws {TypeError} If the configured initialWidth is not a finite integer.
+ * @throws {RangeError} If initialWidth is negative or a theme color is invalid.
  * @since 0.3.0
  */
 type Printer = (message: Message) => void;
@@ -64,6 +66,8 @@ type Printer = (message: Message) => void;
  *
  * @param message The structured message to print.
  * @param options Optional formatting options to override defaults.
+ * @throws {TypeError} If initialWidth is not a finite integer.
+ * @throws {RangeError} If initialWidth is negative or a theme color is invalid.
  *
  * @example
  * ```typescript
@@ -119,7 +123,9 @@ declare function printError(message: Message, options?: PrintErrorOptions): void
  * operations or when you want to override the automatic terminal detection.
  *
  * @param options Formatting options for the printer.
- * @returns A printer function that can be called with messages.
+ * @returns A printer function that can be called with messages. The returned
+ * function validates initialWidth and theme colors when formatting a message
+ * and can throw the exceptions documented on {@link Printer}.
  *
  * @example
  * ```typescript

package/dist/print.d.ts

@@ -52,6 +52,8 @@ interface PrinterOptions extends MessageFormatOptions {
 /**
  * A printer function that outputs formatted messages.
  * @param message The structured message to print.
+ * @throws {TypeError} If the configured initialWidth is not a finite integer.
+ * @throws {RangeError} If initialWidth is negative or a theme color is invalid.
  * @since 0.3.0
  */
 type Printer = (message: Message) => void;
@@ -64,6 +66,8 @@ type Printer = (message: Message) => void;
  *
  * @param message The structured message to print.
  * @param options Optional formatting options to override defaults.
+ * @throws {TypeError} If initialWidth is not a finite integer.
+ * @throws {RangeError} If initialWidth is negative or a theme color is invalid.
  *
  * @example
  * ```typescript
@@ -119,7 +123,9 @@ declare function printError(message: Message, options?: PrintErrorOptions): void
  * operations or when you want to override the automatic terminal detection.
  *
  * @param options Formatting options for the printer.
- * @returns A printer function that can be called with messages.
+ * @returns A printer function that can be called with messages. The returned
+ * function validates initialWidth and theme colors when formatting a message
+ * and can throw the exceptions documented on {@link Printer}.
  *
  * @example
  * ```typescript

package/dist/print.js

@@ -11,6 +11,8 @@ import { getDisplayWidth, renderTerminalTerm, resolveMessageFormatter } from "@o
 *
 * @param message The structured message to print.
 * @param options Optional formatting options to override defaults.
+* @throws {TypeError} If initialWidth is not a finite integer.
+* @throws {RangeError} If initialWidth is negative or a theme color is invalid.
 *
 * @example
 * ```typescript
@@ -70,7 +72,9 @@ function printError(message, options = {}) {
 * operations or when you want to override the automatic terminal detection.
 *
 * @param options Formatting options for the printer.
-* @returns A printer function that can be called with messages.
+* @returns A printer function that can be called with messages. The returned
+* function validates initialWidth and theme colors when formatting a message
+* and can throw the exceptions documented on {@link Printer}.
 *
 * @example
 * ```typescript

package/dist/run.d.cts

@@ -338,6 +338,8 @@ type AcceptExactOptionalRunOptions<TOptions> = [TOptions] extends [RunOptions |
  * @param parser The command-line parser to execute.
  * @param options Configuration options for customizing behavior.
  *                See {@link RunOptions} for available settings.
+ * @throws {RangeError} If rendering help or errors encounters an invalid theme
+ * color, even when colors are disabled.
  * @returns The parsed result if successful. On help display or parse errors,
  *          the function will call `process.exit()` and not return.
  *
@@ -417,6 +419,8 @@ declare function run<T extends Parser<Mode, unknown, unknown>>(parser: T, option
  * @template T The sync parser type being executed.
  * @param parser The synchronous command-line parser to execute.
  * @param options Configuration options for customizing behavior.
+ * @throws {RangeError} If rendering help or errors encounters an invalid theme
+ * color, even when colors are disabled.
  * @returns The parsed result if successful.
  * @throws {TypeError} If an async parser (or a {@link Program} wrapping one)
  * is passed at runtime.  Use {@link run} or {@link runAsync} instead.
@@ -442,6 +446,8 @@ declare function runSync<T extends Parser<"sync", unknown, unknown>>(parser: T,
  * @template T The parser type being executed.
  * @param parser The command-line parser to execute.
  * @param options Configuration options for customizing behavior.
+ * @throws {RangeError} If rendering help or errors encounters an invalid theme
+ * color, even when colors are disabled.
  * @returns A Promise of the parsed result if successful.
  * @since 0.9.0
  */

package/dist/run.d.ts

@@ -338,6 +338,8 @@ type AcceptExactOptionalRunOptions<TOptions> = [TOptions] extends [RunOptions |
  * @param parser The command-line parser to execute.
  * @param options Configuration options for customizing behavior.
  *                See {@link RunOptions} for available settings.
+ * @throws {RangeError} If rendering help or errors encounters an invalid theme
+ * color, even when colors are disabled.
  * @returns The parsed result if successful. On help display or parse errors,
  *          the function will call `process.exit()` and not return.
  *
@@ -417,6 +419,8 @@ declare function run<T extends Parser<Mode, unknown, unknown>>(parser: T, option
  * @template T The sync parser type being executed.
  * @param parser The synchronous command-line parser to execute.
  * @param options Configuration options for customizing behavior.
+ * @throws {RangeError} If rendering help or errors encounters an invalid theme
+ * color, even when colors are disabled.
  * @returns The parsed result if successful.
  * @throws {TypeError} If an async parser (or a {@link Program} wrapping one)
  * is passed at runtime.  Use {@link run} or {@link runAsync} instead.
@@ -442,6 +446,8 @@ declare function runSync<T extends Parser<"sync", unknown, unknown>>(parser: T,
  * @template T The parser type being executed.
  * @param parser The command-line parser to execute.
  * @param options Configuration options for customizing behavior.
+ * @throws {RangeError} If rendering help or errors encounters an invalid theme
+ * color, even when colors are disabled.
  * @returns A Promise of the parsed result if successful.
  * @since 0.9.0
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/run",
-  "version": "1.3.0-dev.2534",
+  "version": "1.3.0-dev.2538",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",
@@ -76,11 +76,11 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@optique/core": "1.3.0-dev.2534+0daf40ee"
+    "@optique/core": "1.3.0-dev.2538+8e1487d7"
   },
   "devDependencies": {
-    "@optique/config": "1.3.0-dev.2534+0daf40ee",
-    "@optique/env": "1.3.0-dev.2534+0daf40ee",
+    "@optique/config": "1.3.0-dev.2538+8e1487d7",
+    "@optique/env": "1.3.0-dev.2538+8e1487d7",
     "@types/node": "^24.0.0",
     "fast-check": "^4.7.0",
     "tsdown": "^0.13.0",