types.FlagType | /x/args.ts | sane_fmt@0.13.0

Opinionated code formatter for TypeScript and JavaScript

interface types.FlagType

import { type types } from "https://deno.land/x/sane_fmt@0.13.0/x/args.ts";
const { FlagType } = types;

Interface of a flag type

Type Parameters

Name extends string

Type of flag's name, preferably literal

Value

Type of flag's value

readonly

name: Name

Flag name

readonly

[[Symbol.toStringTag]]: string

Class name

extract(args: readonly ArgvItem[]): Result<{ value: Value; consumedFlags: ReadonlySet<ArgvItem>; }, FlagError>

Extract value from a list of arguments

Create a FlagHelp to display in help::help() or wrapper::help()