Skip to main content

@std/flags@0.215.0

latest
Works with
It is unknown whether this package works with Browsers, Deno, Node.js, Cloudflare Workers, Bun
It is unknown whether this package works with Browsers
It is unknown whether this package works with Deno
It is unknown whether this package works with Node.js
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Bun
JSR Score82%
Published2 years ago (0.215.0)
interface ParseOptions
Deprecated

(will be removed in 1.0.0) Import from https://deno.land/std/cli/parse_args.ts instead.

The options for the parse call.

Type Parameters

TBooleans extends BooleanType = BooleanType
TStrings extends StringType = StringType
TCollectable extends Collectable = Collectable
TNegatable extends Negatable = Negatable
TDefault extends Record<string, unknown> | undefined = Record<string, unknown> | undefined
TAliases extends Aliases | undefined = Aliases | undefined
TDoubleDash extends boolean | undefined = boolean | undefined

Properties

optional
--: TDoubleDash = false

When true, populate the result _ with everything before the -- and the result ['--'] with everything after the --.

An object mapping string names to strings or arrays of string argument names to use as aliases.

optional
boolean: TBooleans | ReadonlyArray<Extract<TBooleans, string>>

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). All boolean arguments will be set to false by default.

An object mapping string argument names to default values.

When true, populate the result _ with everything after the first non-option.

optional
string: TStrings | ReadonlyArray<Extract<TStrings, string>>

A string or array of strings argument names to always treat as strings.

optional
collect: TCollectable | ReadonlyArray<Extract<TCollectable, string>>

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. All Collectable arguments will be set to [] by default.

optional
negatable: TNegatable | ReadonlyArray<Extract<TNegatable, string>>

A string or array of strings argument names which can be negated by prefixing them with --no-, like --no-config.

optional
unknown: (
arg: string,
key?: string,
value?: unknown
) => unknown

A function which is invoked with a command line parameter not defined in the options configuration object. If the function returns false, the unknown option is not added to parsedArgs.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/flags

Import symbol

import { type ParseOptions } from "@std/flags";
or

Import directly with a jsr specifier

import { type ParseOptions } from "jsr:@std/flags";