harnais v1.0.0 Harnais View Source

Harnais is a family of harnesses for testing Elixir code.

Standard Result API

Many functions return either {:ok, any} or {:error, error} where error will be an Exception.

Peer bang functions return either value or raises error.

Link to this section Summary

Types

ast()

asts()

error()

form()

forms()

key()

keys()

opts()

Functions

__using__(opts \\ [])

The using macro initialises Harnais

Link to this section Types

ast()

ast() :: Macro.t()

asts()

asts() :: [ast()]

error()

error() :: struct()

form()

form() :: Macro.t()

forms()

forms() :: [form()]

key()

key() :: atom()

keys()

keys() :: [key()]

opts()

opts() :: Keyword.t()

Link to this section Functions

__using__(opts \\ []) (macro)

The using macro initialises Harnais.

Examples

use Harnais