import { type flags } from "https://deno.land/x/hex@0.5.15/src/generator/deps.ts";
const { ParseOptions } = flags;
The options for the parse
call.
Properties
When true
, populate the result _
with everything before the --
and
the result ['--']
with everything after the --
. Here's an example:
// $ deno run example.ts -- a arg1
import { parse } from "https://deno.land/std@0.224.0/flags/mod.ts";
console.dir(parse(Deno.args, { "--": false }));
// output: { _: [ "a", "arg1" ] }
console.dir(parse(Deno.args, { "--": true }));
// output: { _: [], --: [ "a", "arg1" ] }
Defaults to false
.
An object mapping string names to strings or arrays of string argument names to use as aliases.
A boolean, string or array of strings to always treat as booleans. If
true
will treat all double hyphenated arguments without equal signs as
boolean
(e.g. affects --foo
, not -f
or --foo=bar
)
When true
, populate the result _
with everything after the first
non-option.
A string or array of strings argument names to always treat as strings.
A string or array of strings argument names to always treat as arrays. Collectable options can be used multiple times. All values will be collected into one array. If a non-collectable option is used multiple times, the last value is used.
A string or array of strings argument names which can be negated
by prefixing them with --no-
, like --no-config
.