Skip to content

baner.md

Latest commit

 

History

History
65 lines (48 loc) · 1.86 KB

baner.md

File metadata and controls

65 lines (48 loc) · 1.86 KB
Raw

parser

export function parser<
    const flags extends readonly Flag<FlagArgument<KnownTypes>, string>[],
>(...flags: flags): ProgramParser<flags> {

A parser is composed of an array of flags View source

help

export function help<
    const flags extends readonly Flag<FlagArgument<KnownTypes>, string>[],
>(flagParser: ProgramParser<flags>): string {

Creates a help text for a given program parser View source

allErrors

export function allErrors<
    const flags extends readonly Flag<FlagArgument<KnownTypes>, string>[],
>(program: Program<flags>): string[] {

Reports all errors in a program, ignoring missing flags. View source

allMissing

export function allMissing<
    const flags extends readonly Flag<FlagArgument<KnownTypes>, string>[],
>(program: Program<flags>, ignore: string[]): string[] {

Reports missing flags, ignoring the ones you don't care about. View source

allValues

export function allValues<
    const flags extends readonly Flag<FlagArgument<KnownTypes>, string>[],
>(program: Program<flags>): ProgramValues<flags> {

Gets the Ok values out of the program as the raw type (i.e a string from string()) View source

parse

export function parse<
    const flags extends readonly Flag<FlagArgument<KnownTypes>, string>[],
>(flagParser: ProgramParser<flags>, args: string[]): Program<flags> {

Runs a flag parser on the args View source