View Source erf_router (erf v0.1.2)

Summary

Types

callback/0
generator_opts/0
t/0

Functions

generate(API, Opts)
Generates an Erlang Syntax Tree of a router module from an API AST.
load(Router)
Loads a router module into the Erlang Runtime System.

Types

Link to this type

callback/0

View Source 
-type callback() :: module().
Link to this type

generator_opts/0

View Source 
-type generator_opts() :: #{callback := callback(), static_routes := [erf:static_route()]}.
Link to this type

t/0

View Source 
-type t() :: erl_syntax:syntaxTree().

Functions

Link to this function

generate(API, Opts)

View Source 
-spec generate(API, Opts) -> Result
                  when
                      API :: erf:api(),
                      Opts :: generator_opts(),
                      Result :: {Mod, Router},
                      Mod :: module(),
                      Router :: t().
Generates an Erlang Syntax Tree of a router module from an API AST.
Link to this function

load(Router)

View Source 
-spec load(Router) -> Result
              when
                  Router :: t(),
                  Result :: ok | {ok, Warnings} | error | {error, {Errors, Warnings}},
                  Errors :: [term()],
                  Warnings :: [term()].
Loads a router module into the Erlang Runtime System.