Mnemonix

v0.10.0

Mnemonix v0.10.0 Mnemonix.Supervisor View Source

A pre-rolled supervisor to complement store.

Link to this section Summary

Types

config()

A two-tuple describing a store type and options to start it

options()

Options used to start a store

Functions

start_link(config, options \\ [])

Creates and supervises a store for each entry in config

Link to this section Types

Link to this type config() View Source 
config() :: {Mnemonix.Store.Behaviour.t(), options()}

A two-tuple describing a store type and options to start it.

Link to this type options() View Source 
options() :: [otp_app: atom(), store: Mnemonix.Store.options(), server: GenServer.opts()]

Options used to start a store.

Link to this section Functions

Link to this function start_link(config, options \\ []) View Source 
start_link(config() | [config()], Supervisor.options()) :: Supervisor.on_start()

Creates and supervises a store for each entry in config.

options are passed verbatim into Supervisor.start_link/3.

config can be a single Mnemonix.Supervisor.config/0 or a list of them.