ToolArgs Interface

Beta  

Represents parsed arguments as name-value pairs.

see parseArgs

Methods

Name Description
get(namePrefix: string): undefined | string Find the value associated with the first argument that begins with the specified prefix, case-insensitively; or undefined if no such argument exists.  
getBoolean(namePrefix: string): undefined | boolean Convert the value associated with the first argument beginning with the specified prefix to a boolean, where "1" indicates true and "0" indicates false.  
getFloat(namePrefix: string): undefined | number 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.  
getInteger(namePrefix: string): undefined | number 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.  

Defined in

Last Updated: 11 June, 2024