Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

ArgParser

Nested types and modules

TypeDescription
Inline

Functions and values

Function or valueDescription
( .>> ) p1 p2
Signature: p1:ArgumentParser<'?18493,'?18494> -> p2:ArgumentParser<'?18493,'?18495> -> IArgumentStream<'?18493> -> Reply<'?18494>
Type parameters: '?18493, '?18494, '?18495
( .>>. ) p1 p2
Signature: p1:ArgumentParser<'?18497,'?18498> -> p2:ArgumentParser<'?18497,'?18499> -> IArgumentStream<'?18497> -> Reply<'?18498 * '?18499>
Type parameters: '?18497, '?18498, '?18499
( |>> ) p f
Signature: p:ArgumentParser<'?18505,'?18506> -> f:('?18506 -> '?18507) -> IArgumentStream<'?18505> -> Reply<'?18507>
Type parameters: '?18505, '?18506, '?18507
( <?> ) p label
Signature: p:ArgumentParser<'u,'a> -> label:string -> ArgumentParser<'u,'a>
Type parameters: 'u, 'a
( <|> ) p1 p2
Signature: p1:ArgumentParser<'?18518,'?18519> -> p2:ArgumentParser<'?18518,'?18519> -> IArgumentStream<'?18518> -> Reply<'?18519>
Type parameters: '?18518, '?18519
( >>% ) p x
Signature: p:ArgumentParser<'?18485,'?18486> -> x:'?18487 -> IArgumentStream<'?18485> -> Reply<'?18487>
Type parameters: '?18485, '?18486, '?18487
( >>. ) p1 p2
Signature: p1:ArgumentParser<'?18489,'?18490> -> p2:ArgumentParser<'?18489,'?18491> -> IArgumentStream<'?18489> -> Reply<'?18491>
Type parameters: '?18489, '?18490, '?18491
( >>= ) p f stream
Signature: p:ArgumentParser<'u,'a> -> f:('a -> ArgumentParser<'u,'b>) -> stream:IArgumentStream<'u> -> Reply<'b>
Type parameters: 'u, 'a, 'b
between popen pclose p
Signature: popen:ArgumentParser<'u,'u> -> pclose:ArgumentParser<'u,'?18502> -> p:ArgumentParser<'u,'?18503> -> IArgumentStream<'u> -> Reply<'?18503>
Type parameters: 'u, '?18502, '?18503
choice ps stream
Signature: ps:seq<ArgumentParser<'u,'a>> -> stream:IArgumentStream<'u> -> Reply<'a>
Type parameters: 'u, 'a
choiceBest ps stream
Signature: ps:seq<ArgumentParser<'u,'a>> -> stream:IArgumentStream<'u> -> Reply<'a>
Type parameters: 'u, 'a
chooseParser itemType chooser stream
Signature: itemType:string -> chooser:(string option -> '?18572 option) -> stream:IArgumentStream<'?18573> -> Reply<'?18572>
Type parameters: '?18572, '?18573
chooseParser' itemType chooser
Signature: itemType:string -> chooser:(string -> '?18578 option) -> IArgumentStream<'?18579> -> Reply<'?18578>
Type parameters: '?18578, '?18579
chooseParserFull itemType chooser stream
Signature: itemType:string -> chooser:(string option -> '?18575 option) -> stream:IArgumentStream<'?18576> -> Reply<'?18575>
Type parameters: '?18575, '?18576
chooseParserFull' itemType chooser
Signature: itemType:string -> chooser:(string -> '?18581 option) -> IArgumentStream<'?18582> -> Reply<'?18581>
Type parameters: '?18581, '?18582
debug map' arg' stream'
Signature: map':('a -> IArgumentStream<'state> -> unit) -> arg':'a -> stream':IArgumentStream<'state> -> Reply<'a>
Type parameters: 'a, 'state
getParser(ast)
Signature: ast:UsageAst -> ArgumentParser<DocoptMap,Map<string,DocoptResult>>
many(p)
Signature: p:ArgumentParser<'?18526,'?18527> -> ArgumentParser<'?18526,'?18527 list>
Type parameters: '?18526, '?18527
many1(p)
Signature: p:ArgumentParser<'?18529,'?18530> -> ArgumentParser<'?18529,'?18530 list>
Type parameters: '?18529, '?18530
mergeMap m1 m2
Signature: m1:Map<'?18601,'?18602> -> m2:Map<'?18601,'?18602> -> Map<'?18601,'?18602>
Type parameters: '?18601, '?18602
mergeMaps(maps)
Signature: maps:seq<Map<'?18604,'?18605>> -> Map<'?18604,'?18605>
Type parameters: '?18604, '?18605
multipleSaveInMap(f)
Signature: f:('?18598 -> '?18599) -> '?18598 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?18598, '?18599
parg(argName)
Signature: argName:string -> IArgumentStream<'?18586> -> Reply<string>
Type parameters: '?18586
pcmd(cmd)
Signature: cmd:string -> IArgumentStream<'?18584> -> Reply<string>
Type parameters: '?18584
pLongFlag(flag)
Signature: flag:SafeOption -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
pOption includeShort o'
Signature: includeShort:bool -> o':SafeOption -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
pOptions allowMissing flags
Signature: allowMissing:bool -> flags:SafeOptions -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
preturn x stream
Signature: x:'?18475 -> stream:IArgumentStream<'?18476> -> Reply<'?18475>
Type parameters: '?18475, '?18476
pseq(ps)
Signature: ps:seq<ArgumentParser<'?18532,Map<'?18533,'?18534>>> -> ArgumentParser<'?18532,Map<'?18533,'?18534>>
Type parameters: '?18532, '?18533, '?18534
pShortFlag(flag)
Signature: flag:SafeOption -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
punorderedseq allowEmpty allowMissing ps
Signature: allowEmpty:bool -> allowMissing:bool -> ps:seq<ArgumentParser<'u,'a>> -> ArgumentParser<'u,'a list>
Type parameters: 'u, 'a
punorderedseqWithMany(...)
Signature: allowEmpty:bool -> allowMissing:bool -> ps:seq<bool * ArgumentParser<'u,'a>> -> stream:IArgumentStream<'u> -> Reply<'a list>
Type parameters: 'u, 'a
pzero(stream)
Signature: stream:IArgumentStream<'?18478> -> Reply<'?18479>
Type parameters: '?18478, '?18479
saveInMap key f
Signature: key:string -> f:('?18594 -> DocoptResult) -> '?18594 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?18594
saveInMapM keys f
Signature: keys:seq<string> -> f:('?18596 -> DocoptResult) -> '?18596 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?18596
updateMap key newItem map
Signature: key:string -> newItem:DocoptResult -> map:Map<string,DocoptResult> -> Map<string,DocoptResult>
updateUserState map' arg' stream'
Signature: map':('a -> DocoptMap -> DocoptMap) -> arg':'a -> stream':IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: 'a