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<'?19325,'?19326> -> p2:ArgumentParser<'?19325,'?19327> -> IArgumentStream<'?19325> -> Reply<'?19326>
Type parameters: '?19325, '?19326, '?19327
( .>>. ) p1 p2
Signature: p1:ArgumentParser<'?19329,'?19330> -> p2:ArgumentParser<'?19329,'?19331> -> IArgumentStream<'?19329> -> Reply<'?19330 * '?19331>
Type parameters: '?19329, '?19330, '?19331
( |>> ) p f
Signature: p:ArgumentParser<'?19337,'?19338> -> f:('?19338 -> '?19339) -> IArgumentStream<'?19337> -> Reply<'?19339>
Type parameters: '?19337, '?19338, '?19339
( <?> ) p label
Signature: p:ArgumentParser<'u,'a> -> label:string -> ArgumentParser<'u,'a>
Type parameters: 'u, 'a
( <|> ) p1 p2
Signature: p1:ArgumentParser<'?19350,'?19351> -> p2:ArgumentParser<'?19350,'?19351> -> IArgumentStream<'?19350> -> Reply<'?19351>
Type parameters: '?19350, '?19351
( >>% ) p x
Signature: p:ArgumentParser<'?19317,'?19318> -> x:'?19319 -> IArgumentStream<'?19317> -> Reply<'?19319>
Type parameters: '?19317, '?19318, '?19319
( >>. ) p1 p2
Signature: p1:ArgumentParser<'?19321,'?19322> -> p2:ArgumentParser<'?19321,'?19323> -> IArgumentStream<'?19321> -> Reply<'?19323>
Type parameters: '?19321, '?19322, '?19323
( >>= ) 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,'?19334> -> p:ArgumentParser<'u,'?19335> -> IArgumentStream<'u> -> Reply<'?19335>
Type parameters: 'u, '?19334, '?19335
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 -> '?19404 option) -> stream:IArgumentStream<'?19405> -> Reply<'?19404>
Type parameters: '?19404, '?19405
chooseParser' itemType chooser
Signature: itemType:string -> chooser:(string -> '?19410 option) -> IArgumentStream<'?19411> -> Reply<'?19410>
Type parameters: '?19410, '?19411
chooseParserFull itemType chooser stream
Signature: itemType:string -> chooser:(string option -> '?19407 option) -> stream:IArgumentStream<'?19408> -> Reply<'?19407>
Type parameters: '?19407, '?19408
chooseParserFull' itemType chooser
Signature: itemType:string -> chooser:(string -> '?19413 option) -> IArgumentStream<'?19414> -> Reply<'?19413>
Type parameters: '?19413, '?19414
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<'?19358,'?19359> -> ArgumentParser<'?19358,'?19359 list>
Type parameters: '?19358, '?19359
many1(p)
Signature: p:ArgumentParser<'?19361,'?19362> -> ArgumentParser<'?19361,'?19362 list>
Type parameters: '?19361, '?19362
mergeMap m1 m2
Signature: m1:Map<'?19433,'?19434> -> m2:Map<'?19433,'?19434> -> Map<'?19433,'?19434>
Type parameters: '?19433, '?19434
mergeMaps(maps)
Signature: maps:seq<Map<'?19436,'?19437>> -> Map<'?19436,'?19437>
Type parameters: '?19436, '?19437
multipleSaveInMap(f)
Signature: f:('?19430 -> '?19431) -> '?19430 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19430, '?19431
parg(argName)
Signature: argName:string -> IArgumentStream<'?19418> -> Reply<string>
Type parameters: '?19418
pcmd(cmd)
Signature: cmd:string -> IArgumentStream<'?19416> -> Reply<string>
Type parameters: '?19416
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:'?19307 -> stream:IArgumentStream<'?19308> -> Reply<'?19307>
Type parameters: '?19307, '?19308
pseq(ps)
Signature: ps:seq<ArgumentParser<'?19364,Map<'?19365,'?19366>>> -> ArgumentParser<'?19364,Map<'?19365,'?19366>>
Type parameters: '?19364, '?19365, '?19366
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<'?19310> -> Reply<'?19311>
Type parameters: '?19310, '?19311
saveInMap key f
Signature: key:string -> f:('?19426 -> DocoptResult) -> '?19426 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19426
saveInMapM keys f
Signature: keys:seq<string> -> f:('?19428 -> DocoptResult) -> '?19428 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19428
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