neuron
neuron v5.1.0

View Source Neuron.Store (neuron v5.1.0)

This module provides a simple way to interface with the process and application environmental variables, acting as a simple KV store.

WARNING: this module is not intended to be used outside of this library.

Link to this section Summary

Functions

current_context(key)

gets the context of a given neuron application/process environmental variable

delete(key)

deletes neuron application/process environmental variables

delete(atom, key)
get(key)

returns neuron application/process environmental variables

get(context, key)
get(atom, key, default)
set(key, value)

sets neuron application/process environmental variables

set(atom, key, value)

Link to this section Functions

Link to this function

current_context(key)

View Source 
@spec current_context(key :: atom()) :: :global | :process

gets the context of a given neuron application/process environmental variable

examples

 Examples 

iex> Neuron.Store.current_context(:my_key)
:global
Link to this function

delete(key)

View Source 
@spec delete(key :: atom()) :: any()

deletes neuron application/process environmental variables

examples

 Examples 

iex> Neuron.Store.delete(:my_key)
:ok
Link to this function

delete(atom, key)

View Source 
@spec delete(context :: :global | :process, key :: atom()) :: :ok
Link to this function

get(key)

View Source 
@spec get(key :: atom()) :: any()

returns neuron application/process environmental variables

examples

 Examples 

iex> Neuron.Store.set(:my_key, "value")
:ok
iex> Neuron.Store.get(:my_key)
"value"
Link to this function

get(context, key)

View Source 
@spec get(context :: :global | :process, key :: atom()) :: any()
Link to this function

get(atom, key, default)

View Source 
@spec get(context :: :global | :process, key :: atom(), default :: any()) :: any()
Link to this function

set(key, value)

View Source 
@spec set(key :: atom(), value :: any()) :: :ok

sets neuron application/process environmental variables

examples

 Examples 

iex> Neuron.Store.set(:my_key, "value")
:ok
Link to this function

set(atom, key, value)

View Source 
@spec set(context :: :global | :process, key :: atom(), value :: any()) :: :ok