radex

v0.1.0

radex v0.1.0 Radex.Metadata View Source

Process for storing metadata about the API

Link to this section Summary

Types

t()

Functions

get(key)

Get information about a test by it’s key

get_all()

Get all metadata in the process

record_conn(key, conn)

Record a Plug.Conn for a key

record_metadata(key, metadata, opts \\ [])

Record metadata about a key

record_success(key)

Record a test as successful

register(key, file, line)

Link to this section Types

Link to this type t() View Source 
t() :: %Radex.Metadata{conns: term, file: term, line: term, metadata: term, success: term}

Link to this section Functions

Link to this function get(key) View Source 
get(key :: String.t) :: map

Get information about a test by it’s key

Link to this function get_all() View Source 
get_all() :: [t]

Get all metadata in the process

For when all tests have completed and documentation will be written

Link to this function record_conn(key, conn) View Source 
record_conn(key :: String.t, conn :: Plug.Conn.t) :: Plug.Conn.t

Record a Plug.Conn for a key

Link to this function record_metadata(key, metadata, opts \\ []) View Source

Record metadata about a key

Link to this function record_success(key) View Source 
record_success(key :: String.t) :: :ok

Record a test as successful

Link to this function register(key, file, line) View Source