args-tokens 0.13.3 → 0.14.0

package/lib/index.d.ts

@@ -1,7 +1,7 @@
 import { ParserOptions } from './parser.js';
 export { ArgToken, parseArgs } from './parser.js';
 import { ArgOptions, ArgValues } from './resolver.js';
-export { ArgOptionSchema, OptionResolveError, resolveArgs } from './resolver.js';
+export { ArgOptionSchema, OptionResolveError, OptionResolveErrorType, resolveArgs } from './resolver.js';
 
 /**
 * Parse options for {@link parse} function.

package/lib/index.js

@@ -1,5 +1,5 @@
 import { parseArgs } from "./parser-DxH6Mf-o.js";
-import { OptionResolveError, resolveArgs } from "./resolver-Di82Qgwx.js";
+import { OptionResolveError, resolveArgs } from "./resolver-BFy1oVrL.js";
 
 //#region src/parse.ts
 const DEFAULT_OPTIONS = {

package/lib/parser.d.ts

@@ -1,4 +1,8 @@
 /**
+* Entry point of argument parser.
+* @module
+*/
+/**
 * Argument token Kind.
 * - `option`: option token, support short option (e.g. `-x`) and long option (e.g. `--foo`)
 * - `option-terminator`: option terminator (`--`) token, see guideline 10 in https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html

package/lib/{resolver-Di82Qgwx.js → resolver-BFy1oVrL.js}

@@ -137,14 +137,16 @@ function resolveArgs(options, tokens) {
 	};
 }
 function createRequireError(option, schema) {
-	return new OptionResolveError(`Option '--${option}' ${schema.short ? `or '-${schema.short}' ` : ""}is required`, option, schema);
+	return new OptionResolveError(`Option '--${option}' ${schema.short ? `or '-${schema.short}' ` : ""}is required`, option, "required", schema);
 }
 var OptionResolveError = class extends Error {
 	name;
 	schema;
-	constructor(message, name, schema) {
+	type;
+	constructor(message, name, type, schema) {
 		super(message);
 		this.name = name;
+		this.type = type;
 		this.schema = schema;
 	}
 };
@@ -167,7 +169,7 @@ function isNumeric(str) {
 	return str.trim() !== "" && !isNaN(str);
 }
 function createTypeError(option, schema) {
-	return new OptionResolveError(`Option '--${option}' ${schema.short ? `or '-${schema.short}' ` : ""}should be '${schema.type}'`, option, schema);
+	return new OptionResolveError(`Option '--${option}' ${schema.short ? `or '-${schema.short}' ` : ""}should be '${schema.type}'`, option, "type", schema);
 }
 function resolveOptionValue(token, schema) {
 	if (token.value) return schema.type === "number" ? +token.value : token.value;

package/lib/resolver.d.ts

@@ -64,14 +64,19 @@ declare function resolveArgs<T extends ArgOptions>(options: T, tokens: ArgToken[
 	error: AggregateError | undefined
 };
 /**
+* An error type for {@link OptionResolveError}.
+*/
+type OptionResolveErrorType = "type" | "required";
+/**
 * An error that occurs when resolving options.
 * This error is thrown when the option is not valid.
 */
 declare class OptionResolveError extends Error {
 	name: string;
 	schema: ArgOptionSchema;
-	constructor(message: string, name: string, schema: ArgOptionSchema);
+	type: OptionResolveErrorType;
+	constructor(message: string, name: string, type: OptionResolveErrorType, schema: ArgOptionSchema);
 }
 
 export { OptionResolveError, resolveArgs };
-export type { ArgOptionSchema, ArgOptions, ArgValues };
+export type { ArgOptionSchema, ArgOptions, ArgValues, OptionResolveErrorType };

package/lib/resolver.js

@@ -1,4 +1,4 @@
 import "./parser-DxH6Mf-o.js";
-import { OptionResolveError, resolveArgs } from "./resolver-Di82Qgwx.js";
+import { OptionResolveError, resolveArgs } from "./resolver-BFy1oVrL.js";
 
 export { OptionResolveError, resolveArgs };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "args-tokens",
   "description": "parseArgs tokens compatibility and more high-performance parser",
-  "version": "0.13.3",
+  "version": "0.14.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"