View Source erlarg (erlarg v1.0.0)

Summary

Types

args/0

-type args() :: [string()].

opt/0

-opaque opt()

spec/0

-type spec() :: map().

syntax/0

-opaque syntax()

Functions

opt(Command, Name)

-spec opt(Command, Name) -> Option
             when
                 Command :: string() | undefined | {string() | undefined, string() | undefined},
                 Name :: atom(),
                 Option :: opt().

opt(Command, Name, Syntax)

-spec opt(Command, Name, Syntax) -> Option
             when
                 Command :: string() | undefined | {string() | undefined, string() | undefined},
                 Name :: atom(),
                 Syntax :: syntax() | undefined,
                 Option :: opt().

parse(Args, Syntax)

-spec parse(Args, Syntax) -> Options | Error
               when Args :: args(), Syntax :: syntax(), Options :: {ok, {any(), args()}}, Error :: error.

parse(Args, Syntax, Aliases)

-spec parse(Args, Syntax, Aliases) -> Options | Error
               when
                   Args :: args(),
                   Syntax :: syntax(),
                   Aliases :: map(),
                   Options :: {ok, {any(), args()}},
                   Error :: error.