@clerc/parser 1.0.0-beta.19 → 1.0.0-beta.20

package/dist/index.d.ts

@@ -29,7 +29,7 @@ type FlagDefaultValue<T = unknown> = T | FlagDefaultValueFunction<T>;
 *
 * @template T The target type.
 */
-interface FlagTypeFunction<T = unknown> {
+interface TypeFunction<T = unknown> {
   (value: string): T;
   /**
   * Optional display name for the type, useful in help output.
@@ -46,7 +46,7 @@ interface FlagTypeFunction<T = unknown> {
 * @returns true to stop parsing, false to continue
 */
 type IgnoreFunction = (type: typeof KNOWN_FLAG | typeof UNKNOWN_FLAG | typeof PARAMETER, arg: string) => boolean;
-type FlagType<T = unknown> = FlagTypeFunction<T> | readonly [FlagTypeFunction<T>];
+type FlagType<T = unknown> = TypeFunction<T> | readonly [TypeFunction<T>];
 interface BaseFlagOptions<T extends FlagType = FlagType> {
   /**
   * The type constructor or a function to convert the string value.
@@ -153,7 +153,7 @@ type InferFlags<T extends FlagsDefinition> = Prettify<_InferFlags<T>>;
 * The display name will be formatted as "value1 | value2 | ..." for help output.
 *
 * @param values - Array of allowed string values
-* @returns A FlagTypeFunction that validates and returns the input value
+* @returns A TypeFunction that validates and returns the input value
 * @throws {Error} If the value is not in the allowed values list
 *
 * @example
@@ -162,25 +162,25 @@ type InferFlags<T extends FlagsDefinition> = Prettify<_InferFlags<T>>;
 * // Help output will show: json | yaml | xml
 * ```
 */
-declare function Enum<T extends string>(...values: T[]): FlagTypeFunction<T>;
+declare function Enum<T extends string>(...values: T[]): TypeFunction<T>;
 /**
 * Creates a range type function that validates the input is a number within the specified range.
 *
 * @param min - The minimum acceptable value (inclusive)
 * @param max - The maximum acceptable value (inclusive)
-* @returns A FlagTypeFunction that validates the input value
+* @returns A TypeFunction that validates the input value
 * @throws {Error} If the value is not a number or is outside the specified range
 */
-declare function Range(min: number, max: number): FlagTypeFunction<number>;
+declare function Range(min: number, max: number): TypeFunction<number>;
 /**
 * Creates a regex type function that validates the input against the provided pattern.
 *
 * @param pattern - The regular expression pattern to validate against
 * @param description - Optional description for display purposes
-* @returns A FlagTypeFunction that validates the input value
+* @returns A TypeFunction that validates the input value
 * @throws {Error} If the value does not match the regex pattern
 */
-declare function Regex(pattern: RegExp, description?: string): FlagTypeFunction<string>;
+declare function Regex(pattern: RegExp, description?: string): TypeFunction<string>;
 //#endregion
 //#region src/parse.d.ts
 declare const DOUBLE_DASH = "--";
@@ -190,4 +190,4 @@ declare function createParser<T extends FlagsDefinition>(options?: ParserOptions
 };
 declare const parse: <T extends FlagsDefinition>(args: string[], options?: ParserOptions<T>) => ParsedResult<InferFlags<T>>;
 //#endregion
-export { BaseFlagOptions, DOUBLE_DASH, Enum, FlagDefaultValue, FlagDefaultValueFunction, FlagDefinitionValue, FlagOptions, FlagType, FlagTypeFunction, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, Range, RawInputType, Regex, UNKNOWN_FLAG, createParser, parse };
+export { BaseFlagOptions, DOUBLE_DASH, Enum, FlagDefaultValue, FlagDefaultValueFunction, FlagDefinitionValue, FlagOptions, FlagType, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, Range, RawInputType, Regex, TypeFunction, UNKNOWN_FLAG, createParser, parse };

package/dist/index.js

@@ -19,7 +19,7 @@ var MissingRequiredFlagError = class extends Error {
 * The display name will be formatted as "value1 | value2 | ..." for help output.
 *
 * @param values - Array of allowed string values
-* @returns A FlagTypeFunction that validates and returns the input value
+* @returns A TypeFunction that validates and returns the input value
 * @throws {Error} If the value is not in the allowed values list
 *
 * @example
@@ -41,7 +41,7 @@ function Enum(...values) {
 *
 * @param min - The minimum acceptable value (inclusive)
 * @param max - The maximum acceptable value (inclusive)
-* @returns A FlagTypeFunction that validates the input value
+* @returns A TypeFunction that validates the input value
 * @throws {Error} If the value is not a number or is outside the specified range
 */
 function Range(min, max) {
@@ -58,7 +58,7 @@ function Range(min, max) {
 *
 * @param pattern - The regular expression pattern to validate against
 * @param description - Optional description for display purposes
-* @returns A FlagTypeFunction that validates the input value
+* @returns A TypeFunction that validates the input value
 * @throws {Error} If the value does not match the regex pattern
 */
 function Regex(pattern, description) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/parser",
-  "version": "1.0.0-beta.19",
+  "version": "1.0.0-beta.20",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc parser",
@@ -56,6 +56,6 @@
     "nopt": "^9.0.0",
     "type-flag": "^4.0.3",
     "yargs-parser": "^22.0.0",
-    "@clerc/utils": "1.0.0-beta.19"
+    "@clerc/utils": "1.0.0-beta.20"
   }
 }