@itwin/frontend-devtools
Version:
Debug menu and supporting UI widgets
24 lines • 1.36 kB
TypeScript
/** @packageDocumentation
* @module Tools
*/
/** Represents parsed arguments as name-value pairs.
* @see [[parseArgs]]
* @beta
*/
export interface ToolArgs {
/** Find the value associated with the first argument that begins with the specified prefix, case-insensitively; or undefined if no such argument exists. */
get(namePrefix: string): string | undefined;
/** Convert the value associated with the first argument beginning with the specified prefix to an integer; return undefined if not found or not an integer. */
getInteger(namePrefix: string): number | undefined;
/** Convert the value associated with the first argument beginning with the specified prefix to a boolean, where "1" indicates true and "0" indicates false. */
getBoolean(namePrefix: string): boolean | undefined;
/** Convert the value associated with the first argument beginning with the specified prefix to a float; return undefined if not found or not a float. */
getFloat(namePrefix: string): number | undefined;
}
/** Given a list of arguments, parse the arguments into name-value pairs.
* Each input string is expected to be of the format "name=value".
* Argument names are converted to lower-case; values are left untouched.
* @beta
*/
export declare function parseArgs(args: string[]): ToolArgs;
//# sourceMappingURL=parseArgs.d.ts.map