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<'?19581,'?19582> -> p2:ArgumentParser<'?19581,'?19583> -> IArgumentStream<'?19581> -> Reply<'?19582>
Type parameters: '?19581, '?19582, '?19583
( .>>. ) p1 p2
Signature: p1:ArgumentParser<'?19585,'?19586> -> p2:ArgumentParser<'?19585,'?19587> -> IArgumentStream<'?19585> -> Reply<'?19586 * '?19587>
Type parameters: '?19585, '?19586, '?19587
( |>> ) p f
Signature: p:ArgumentParser<'?19593,'?19594> -> f:('?19594 -> '?19595) -> IArgumentStream<'?19593> -> Reply<'?19595>
Type parameters: '?19593, '?19594, '?19595
( <?> ) p label
Signature: p:ArgumentParser<'u,'a> -> label:string -> ArgumentParser<'u,'a>
Type parameters: 'u, 'a
( <|> ) p1 p2
Signature: p1:ArgumentParser<'?19606,'?19607> -> p2:ArgumentParser<'?19606,'?19607> -> IArgumentStream<'?19606> -> Reply<'?19607>
Type parameters: '?19606, '?19607
( >>% ) p x
Signature: p:ArgumentParser<'?19573,'?19574> -> x:'?19575 -> IArgumentStream<'?19573> -> Reply<'?19575>
Type parameters: '?19573, '?19574, '?19575
( >>. ) p1 p2
Signature: p1:ArgumentParser<'?19577,'?19578> -> p2:ArgumentParser<'?19577,'?19579> -> IArgumentStream<'?19577> -> Reply<'?19579>
Type parameters: '?19577, '?19578, '?19579
( >>= ) 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,'?19590> -> p:ArgumentParser<'u,'?19591> -> IArgumentStream<'u> -> Reply<'?19591>
Type parameters: 'u, '?19590, '?19591
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 -> '?19660 option) -> stream:IArgumentStream<'?19661> -> Reply<'?19660>
Type parameters: '?19660, '?19661
chooseParser' itemType chooser
Signature: itemType:string -> chooser:(string -> '?19666 option) -> IArgumentStream<'?19667> -> Reply<'?19666>
Type parameters: '?19666, '?19667
chooseParserFull itemType chooser stream
Signature: itemType:string -> chooser:(string option -> '?19663 option) -> stream:IArgumentStream<'?19664> -> Reply<'?19663>
Type parameters: '?19663, '?19664
chooseParserFull' itemType chooser
Signature: itemType:string -> chooser:(string -> '?19669 option) -> IArgumentStream<'?19670> -> Reply<'?19669>
Type parameters: '?19669, '?19670
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<'?19614,'?19615> -> ArgumentParser<'?19614,'?19615 list>
Type parameters: '?19614, '?19615
many1(p)
Signature: p:ArgumentParser<'?19617,'?19618> -> ArgumentParser<'?19617,'?19618 list>
Type parameters: '?19617, '?19618
mergeMap m1 m2
Signature: m1:Map<'?19689,'?19690> -> m2:Map<'?19689,'?19690> -> Map<'?19689,'?19690>
Type parameters: '?19689, '?19690
mergeMaps(maps)
Signature: maps:seq<Map<'?19692,'?19693>> -> Map<'?19692,'?19693>
Type parameters: '?19692, '?19693
multipleSaveInMap(f)
Signature: f:('?19686 -> '?19687) -> '?19686 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19686, '?19687
parg(argName)
Signature: argName:string -> IArgumentStream<'?19674> -> Reply<string>
Type parameters: '?19674
pcmd(cmd)
Signature: cmd:string -> IArgumentStream<'?19672> -> Reply<string>
Type parameters: '?19672
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:'?19563 -> stream:IArgumentStream<'?19564> -> Reply<'?19563>
Type parameters: '?19563, '?19564
pseq(ps)
Signature: ps:seq<ArgumentParser<'?19620,Map<'?19621,'?19622>>> -> ArgumentParser<'?19620,Map<'?19621,'?19622>>
Type parameters: '?19620, '?19621, '?19622
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<'?19566> -> Reply<'?19567>
Type parameters: '?19566, '?19567
saveInMap key f
Signature: key:string -> f:('?19682 -> DocoptResult) -> '?19682 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19682
saveInMapM keys f
Signature: keys:seq<string> -> f:('?19684 -> DocoptResult) -> '?19684 -> IArgumentStream<DocoptMap> -> Reply<DocoptMap>
Type parameters: '?19684
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