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<'?19318,'?19319> -> p2:ArgumentParser<'?19318,'?19320> -> IArgumentStream<'?19318> -> Reply<'?19319>
Type parameters: '?19318, '?19319, '?19320
( .>>. ) p1 p2
Signature: p1:ArgumentParser<'?19322,'?19323> -> p2:ArgumentParser<'?19322,'?19324> -> IArgumentStream<'?19322> -> Reply<'?19323 * '?19324>
Type parameters: '?19322, '?19323, '?19324
( |>> ) p f
Signature: p:ArgumentParser<'?19330,'?19331> -> f:('?19331 -> '?19332) -> IArgumentStream<'?19330> -> Reply<'?19332>
Type parameters: '?19330, '?19331, '?19332
( <?> ) p label
Signature: p:ArgumentParser<'u,'a> -> label:string -> ArgumentParser<'u,'a>
Type parameters: 'u, 'a
( <|> ) p1 p2
Signature: p1:ArgumentParser<'?19343,'?19344> -> p2:ArgumentParser<'?19343,'?19344> -> IArgumentStream<'?19343> -> Reply<'?19344>
Type parameters: '?19343, '?19344
( >>% ) p x
Signature: p:ArgumentParser<'?19310,'?19311> -> x:'?19312 -> IArgumentStream<'?19310> -> Reply<'?19312>
Type parameters: '?19310, '?19311, '?19312
( >>. ) p1 p2
Signature: p1:ArgumentParser<'?19314,'?19315> -> p2:ArgumentParser<'?19314,'?19316> -> IArgumentStream<'?19314> -> Reply<'?19316>
Type parameters: '?19314, '?19315, '?19316
( >>= ) 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,'?19327> -> p:ArgumentParser<'u,'?19328> -> IArgumentStream<'u> -> Reply<'?19328>
Type parameters: 'u, '?19327, '?19328
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 -> '?19397 option) -> stream:IArgumentStream<'?19398> -> Reply<'?19397>
Type parameters: '?19397, '?19398
chooseParser' itemType chooser
Signature: itemType:string -> chooser:(string -> '?19403 option) -> IArgumentStream<'?19404> -> Reply<'?19403>
Type parameters: '?19403, '?19404
chooseParserFull itemType chooser stream
Signature: itemType:string -> chooser:(string option -> '?19400 option) -> stream:IArgumentStream<'?19401> -> Reply<'?19400>
Type parameters: '?19400, '?19401
chooseParserFull' itemType chooser
Signature: itemType:string -> chooser:(string -> '?19406 option) -> IArgumentStream<'?19407> -> Reply<'?19406>
Type parameters: '?19406, '?19407
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<'?19351,'?19352> -> ArgumentParser<'?19351,'?19352 list>
Type parameters: '?19351, '?19352
many1(p)
Signature: p:ArgumentParser<'?19354,'?19355> -> ArgumentParser<'?19354,'?19355 list>
Type parameters: '?19354, '?19355
mergeMap m1 m2
Signature: m1:Map<'?19426,'?19427> -> m2:Map<'?19426,'?19427> -> Map<'?19426,'?19427>
Type parameters: '?19426, '?19427
mergeMaps(maps)
Signature: maps:seq<Map<'?19429,'?19430>> -> Map<'?19429,'?19430>
Type parameters: '?19429, '?19430
multipleSaveInMap(f)
Signature: f:('?19423 -> '?19424) -> '?19423 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19423, '?19424
parg(argName)
Signature: argName:string -> IArgumentStream<'?19411> -> Reply<string>
Type parameters: '?19411
pcmd(cmd)
Signature: cmd:string -> IArgumentStream<'?19409> -> Reply<string>
Type parameters: '?19409
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:'?19300 -> stream:IArgumentStream<'?19301> -> Reply<'?19300>
Type parameters: '?19300, '?19301
pseq(ps)
Signature: ps:seq<ArgumentParser<'?19357,Map<'?19358,'?19359>>> -> ArgumentParser<'?19357,Map<'?19358,'?19359>>
Type parameters: '?19357, '?19358, '?19359
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<'?19303> -> Reply<'?19304>
Type parameters: '?19303, '?19304
saveInMap key f
Signature: key:string -> f:('?19419 -> DocoptResult) -> '?19419 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19419
saveInMapM keys f
Signature: keys:seq<string> -> f:('?19421 -> DocoptResult) -> '?19421 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19421
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