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<'?18927,'?18928> -> p2:ArgumentParser<'?18927,'?18929> -> IArgumentStream<'?18927> -> Reply<'?18928>
Type parameters: '?18927, '?18928, '?18929
( .>>. ) p1 p2
Signature: p1:ArgumentParser<'?18931,'?18932> -> p2:ArgumentParser<'?18931,'?18933> -> IArgumentStream<'?18931> -> Reply<'?18932 * '?18933>
Type parameters: '?18931, '?18932, '?18933
( |>> ) p f
Signature: p:ArgumentParser<'?18939,'?18940> -> f:('?18940 -> '?18941) -> IArgumentStream<'?18939> -> Reply<'?18941>
Type parameters: '?18939, '?18940, '?18941
( <?> ) p label
Signature: p:ArgumentParser<'u,'a> -> label:string -> ArgumentParser<'u,'a>
Type parameters: 'u, 'a
( <|> ) p1 p2
Signature: p1:ArgumentParser<'?18952,'?18953> -> p2:ArgumentParser<'?18952,'?18953> -> IArgumentStream<'?18952> -> Reply<'?18953>
Type parameters: '?18952, '?18953
( >>% ) p x
Signature: p:ArgumentParser<'?18919,'?18920> -> x:'?18921 -> IArgumentStream<'?18919> -> Reply<'?18921>
Type parameters: '?18919, '?18920, '?18921
( >>. ) p1 p2
Signature: p1:ArgumentParser<'?18923,'?18924> -> p2:ArgumentParser<'?18923,'?18925> -> IArgumentStream<'?18923> -> Reply<'?18925>
Type parameters: '?18923, '?18924, '?18925
( >>= ) 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,'?18936> -> p:ArgumentParser<'u,'?18937> -> IArgumentStream<'u> -> Reply<'?18937>
Type parameters: 'u, '?18936, '?18937
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 -> '?19006 option) -> stream:IArgumentStream<'?19007> -> Reply<'?19006>
Type parameters: '?19006, '?19007
chooseParser' itemType chooser
Signature: itemType:string -> chooser:(string -> '?19012 option) -> IArgumentStream<'?19013> -> Reply<'?19012>
Type parameters: '?19012, '?19013
chooseParserFull itemType chooser stream
Signature: itemType:string -> chooser:(string option -> '?19009 option) -> stream:IArgumentStream<'?19010> -> Reply<'?19009>
Type parameters: '?19009, '?19010
chooseParserFull' itemType chooser
Signature: itemType:string -> chooser:(string -> '?19015 option) -> IArgumentStream<'?19016> -> Reply<'?19015>
Type parameters: '?19015, '?19016
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<'?18960,'?18961> -> ArgumentParser<'?18960,'?18961 list>
Type parameters: '?18960, '?18961
many1(p)
Signature: p:ArgumentParser<'?18963,'?18964> -> ArgumentParser<'?18963,'?18964 list>
Type parameters: '?18963, '?18964
mergeMap m1 m2
Signature: m1:Map<'?19035,'?19036> -> m2:Map<'?19035,'?19036> -> Map<'?19035,'?19036>
Type parameters: '?19035, '?19036
mergeMaps(maps)
Signature: maps:seq<Map<'?19038,'?19039>> -> Map<'?19038,'?19039>
Type parameters: '?19038, '?19039
multipleSaveInMap(f)
Signature: f:('?19032 -> '?19033) -> '?19032 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19032, '?19033
parg(argName)
Signature: argName:string -> IArgumentStream<'?19020> -> Reply<string>
Type parameters: '?19020
pcmd(cmd)
Signature: cmd:string -> IArgumentStream<'?19018> -> Reply<string>
Type parameters: '?19018
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:'?18909 -> stream:IArgumentStream<'?18910> -> Reply<'?18909>
Type parameters: '?18909, '?18910
pseq(ps)
Signature: ps:seq<ArgumentParser<'?18966,Map<'?18967,'?18968>>> -> ArgumentParser<'?18966,Map<'?18967,'?18968>>
Type parameters: '?18966, '?18967, '?18968
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<'?18912> -> Reply<'?18913>
Type parameters: '?18912, '?18913
saveInMap key f
Signature: key:string -> f:('?19028 -> DocoptResult) -> '?19028 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19028
saveInMapM keys f
Signature: keys:seq<string> -> f:('?19030 -> DocoptResult) -> '?19030 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19030
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