Deno/std
1
0
Fork 0
mirror of https://github.com/denoland/std.git synced 2024-11-22 04:59:05 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs(cli): documentation tweaks (#5458)

Browse Source
This commit is contained in:
Asher Gomez 2024-07-17 11:46:48 +10:00 committed by GitHub
parent 38dbb1a020
commit 317a0d8773
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
cli/parse_args.ts
View File

@ -237,7 +237,7 @@ type Dedot<TKey extends string, TValue> = TKey extends
type ValueOf<TValue> = TValue[keyof TValue];
/** The value returned from `parseArgs`. */
/** The value returned from {@linkcode parseArgs}. */
export type Args<
// deno-lint-ignore no-explicit-any
TArgs extends Record<string, unknown> = Record<string, any>,
@ -260,7 +260,7 @@ type DoubleDash = {
"--"?: Array<string>;
};
/** The options for the `parseArgs` call. */
/** Options for {@linkcode parseArgs}. */
export interface ParseOptions<
TBooleans extends BooleanType = BooleanType,
TStrings extends StringType = StringType,
@ -435,12 +435,12 @@ const FLAG_REGEXP =
* considered a key-value pair. Any arguments which could not be parsed are
* available in the `_` property of the returned object.
*
* By default, the flags module tries to determine the type of all arguments
* automatically and the return type of the `parseArgs` method will have an index
* By default, this module tries to determine the type of all arguments
* automatically and the return type of this function will have an index
* signature with `any` as value (`{ [x: string]: any }`).
*
* If the `string`, `boolean` or `collect` option is set, the return value of
* the `parseArgs` method will be fully typed and the index signature of the return
* this function will be fully typed and the index signature of the return
* type will change to `{ [x: string]: unknown }`.
*
* Any arguments after `'--'` will not be parsed and will end up in `parsedArgs._`.