@optique/core 1.0.0-dev.1228 → 1.0.0-dev.1236

package/dist/facade.cjs

@@ -1104,9 +1104,12 @@ function runParser(parserOrProgram, programNameOrArgs, argsOrOptions, optionsPar
 * @param args The command-line arguments to parse.
 * @param options Configuration options for customizing behavior.
 * @returns The parsed result if successful.
+* @throws {TypeError} If an async parser is passed at runtime.  Use
+* {@link runParser} or {@link runParserAsync} for async parsers.
 * @since 0.9.0
 */
 function runParserSync(parser, programName, args, options) {
+	if (parser.$mode !== "sync") throw new TypeError("Cannot use an async parser with runParserSync(). Use runParser() or runParserAsync() instead.");
 	return runParser(parser, programName, args, options);
 }
 /**
@@ -1465,11 +1468,14 @@ async function runWith(parser, programName, contexts, options) {
 * @param contexts Source contexts to use (priority: earlier overrides later).
 * @param options Run options including args, help, version, etc.
 * @returns The parsed result.
-* @throws Error if any context returns a Promise or if a context's
+* @throws {TypeError} If an async parser is passed at runtime.  Use
+* {@link runWith} or {@link runWithAsync} for async parsers.
+* @throws {Error} If any context returns a Promise or if a context's
 * `[Symbol.asyncDispose]` returns a Promise.
 * @since 0.10.0
 */
 function runWithSync(parser, programName, contexts, options) {
+	if (parser.$mode !== "sync") throw new TypeError("Cannot use an async parser with runWithSync(). Use runWith() or runWithAsync() instead.");
 	const args = options?.args ?? [];
 	if (needsEarlyExit(args, options)) return runParser(parser, programName, args, options);
 	if (contexts.length === 0) return runParser(parser, programName, args, options);

package/dist/facade.d.cts

@@ -301,6 +301,8 @@ declare function runParser<TParser extends Parser<Mode, unknown, unknown>, THelp
  * @param args The command-line arguments to parse.
  * @param options Configuration options for customizing behavior.
  * @returns The parsed result if successful.
+ * @throws {TypeError} If an async parser is passed at runtime.  Use
+ * {@link runParser} or {@link runParserAsync} for async parsers.
  * @since 0.9.0
  */
 declare function runParserSync<TParser extends Parser<"sync", unknown, unknown>, THelp = void, TError = never>(parser: TParser, programName: string, args: readonly string[], options?: RunOptions<THelp, TError>): InferValue<TParser>;
@@ -461,7 +463,9 @@ declare function runWith<TParser extends Parser<Mode, unknown, unknown>, TContex
  * @param contexts Source contexts to use (priority: earlier overrides later).
  * @param options Run options including args, help, version, etc.
  * @returns The parsed result.
- * @throws Error if any context returns a Promise or if a context's
+ * @throws {TypeError} If an async parser is passed at runtime.  Use
+ * {@link runWith} or {@link runWithAsync} for async parsers.
+ * @throws {Error} If any context returns a Promise or if a context's
  * `[Symbol.asyncDispose]` returns a Promise.
  * @since 0.10.0
  */

package/dist/facade.d.ts

@@ -301,6 +301,8 @@ declare function runParser<TParser extends Parser<Mode, unknown, unknown>, THelp
  * @param args The command-line arguments to parse.
  * @param options Configuration options for customizing behavior.
  * @returns The parsed result if successful.
+ * @throws {TypeError} If an async parser is passed at runtime.  Use
+ * {@link runParser} or {@link runParserAsync} for async parsers.
  * @since 0.9.0
  */
 declare function runParserSync<TParser extends Parser<"sync", unknown, unknown>, THelp = void, TError = never>(parser: TParser, programName: string, args: readonly string[], options?: RunOptions<THelp, TError>): InferValue<TParser>;
@@ -461,7 +463,9 @@ declare function runWith<TParser extends Parser<Mode, unknown, unknown>, TContex
  * @param contexts Source contexts to use (priority: earlier overrides later).
  * @param options Run options including args, help, version, etc.
  * @returns The parsed result.
- * @throws Error if any context returns a Promise or if a context's
+ * @throws {TypeError} If an async parser is passed at runtime.  Use
+ * {@link runWith} or {@link runWithAsync} for async parsers.
+ * @throws {Error} If any context returns a Promise or if a context's
  * `[Symbol.asyncDispose]` returns a Promise.
  * @since 0.10.0
  */

package/dist/facade.js

@@ -1104,9 +1104,12 @@ function runParser(parserOrProgram, programNameOrArgs, argsOrOptions, optionsPar
 * @param args The command-line arguments to parse.
 * @param options Configuration options for customizing behavior.
 * @returns The parsed result if successful.
+* @throws {TypeError} If an async parser is passed at runtime.  Use
+* {@link runParser} or {@link runParserAsync} for async parsers.
 * @since 0.9.0
 */
 function runParserSync(parser, programName, args, options) {
+	if (parser.$mode !== "sync") throw new TypeError("Cannot use an async parser with runParserSync(). Use runParser() or runParserAsync() instead.");
 	return runParser(parser, programName, args, options);
 }
 /**
@@ -1465,11 +1468,14 @@ async function runWith(parser, programName, contexts, options) {
 * @param contexts Source contexts to use (priority: earlier overrides later).
 * @param options Run options including args, help, version, etc.
 * @returns The parsed result.
-* @throws Error if any context returns a Promise or if a context's
+* @throws {TypeError} If an async parser is passed at runtime.  Use
+* {@link runWith} or {@link runWithAsync} for async parsers.
+* @throws {Error} If any context returns a Promise or if a context's
 * `[Symbol.asyncDispose]` returns a Promise.
 * @since 0.10.0
 */
 function runWithSync(parser, programName, contexts, options) {
+	if (parser.$mode !== "sync") throw new TypeError("Cannot use an async parser with runWithSync(). Use runWith() or runWithAsync() instead.");
 	const args = options?.args ?? [];
 	if (needsEarlyExit(args, options)) return runParser(parser, programName, args, options);
 	if (contexts.length === 0) return runParser(parser, programName, args, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/core",
-  "version": "1.0.0-dev.1228+2971180c",
+  "version": "1.0.0-dev.1236+3ee9891d",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",