@jil/args
Version:
A convention based argument parsing and formatting library, with strict validation checks
36 lines (35 loc) • 2.29 kB
TypeScript
declare const errors: {
COMMAND_INVALID_FORMAT: string;
COMMAND_NOT_FIRST: string;
COMMAND_PROVIDED: string;
CONTEXT_REQUIRED: string;
GROUP_REQUIRED_COUNT: string;
GROUP_UNSUPPORTED_TYPE: string;
OPTION_INVALID_COUNT_TYPE: string;
OPTION_UNKNOWN: string;
OPTION_UNKNOWN_FORMAT: string;
OPTION_UNKNOWN_MORE: string;
PARAM_INVALID_ORDER: string;
PARAM_REQUIRED: string;
PARAM_REQUIRED_NO_DEFAULT: string;
PARAM_UNKNOWN: string;
SHORT_DEFINED: string;
SHORT_INVALID_CHAR: string;
SHORT_UNKNOWN: string;
VALUE_INVALID_ARITY: string;
VALUE_INVALID_CHOICE: string;
VALUE_INVALID_FORMAT: string;
VALUE_NO_INLINE: string;
VALUE_NON_ARRAY: string;
VALUE_NON_BOOL: string;
VALUE_NON_NUMBER: string;
VALUE_NON_STRING: string;
};
export type ArgsErrorCode = keyof typeof errors;
export declare const ArgsError: new (code: "COMMAND_INVALID_FORMAT" | "COMMAND_NOT_FIRST" | "COMMAND_PROVIDED" | "CONTEXT_REQUIRED" | "GROUP_REQUIRED_COUNT" | "GROUP_UNSUPPORTED_TYPE" | "OPTION_INVALID_COUNT_TYPE" | "OPTION_UNKNOWN" | "OPTION_UNKNOWN_FORMAT" | "OPTION_UNKNOWN_MORE" | "PARAM_INVALID_ORDER" | "PARAM_REQUIRED" | "PARAM_REQUIRED_NO_DEFAULT" | "PARAM_UNKNOWN" | "SHORT_DEFINED" | "SHORT_INVALID_CHAR" | "SHORT_UNKNOWN" | "VALUE_INVALID_ARITY" | "VALUE_INVALID_CHOICE" | "VALUE_INVALID_FORMAT" | "VALUE_NO_INLINE" | "VALUE_NON_ARRAY" | "VALUE_NON_BOOL" | "VALUE_NON_NUMBER" | "VALUE_NON_STRING", params?: unknown[] | undefined) => Error & import("@jil/common/errors/scoped").ScopedError<"COMMAND_INVALID_FORMAT" | "COMMAND_NOT_FIRST" | "COMMAND_PROVIDED" | "CONTEXT_REQUIRED" | "GROUP_REQUIRED_COUNT" | "GROUP_UNSUPPORTED_TYPE" | "OPTION_INVALID_COUNT_TYPE" | "OPTION_UNKNOWN" | "OPTION_UNKNOWN_FORMAT" | "OPTION_UNKNOWN_MORE" | "PARAM_INVALID_ORDER" | "PARAM_REQUIRED" | "PARAM_REQUIRED_NO_DEFAULT" | "PARAM_UNKNOWN" | "SHORT_DEFINED" | "SHORT_INVALID_CHAR" | "SHORT_UNKNOWN" | "VALUE_INVALID_ARITY" | "VALUE_INVALID_CHOICE" | "VALUE_INVALID_FORMAT" | "VALUE_NO_INLINE" | "VALUE_NON_ARRAY" | "VALUE_NON_BOOL" | "VALUE_NON_NUMBER" | "VALUE_NON_STRING">;
export declare class ParseError extends Error {
arg: string;
index: number;
constructor(message: string, arg: string, index: number);
}
export {};