ashton

v0.3.7

ashton v0.3.7 Ashton View Source

Documentation for Ashton.

Link to this section Summary

Types

error()
schema()
validation_result()

Functions

document(schema)

See Ashton.Doc.document/1.

document(schema, opts)

See Ashton.Doc.document/2

merge(left, right)

See Ashton.Schema.merge/2

merge(left, right, opts)

See Ashton.Schema.merge/3.

schema()

See Ashton.Schema.new/0.

schema(opts)

See Ashton.Schema.new/1

validate(opts, schema)
validate!(opts, schema)

Validates opts according to a schema or the constructor for a schema. Raises on invalid opts.

Link to this section Types

Link to this type

error() View Source 
error() :: {atom(), String.t()}

Link to this type

schema() View Source 
schema() :: Ashton.Schema.t()

Link to this type

validation_result() View Source 
validation_result() :: {:ok, Keyword.t()} | {:error, [error()]}

Link to this section Functions

Link to this function

document(schema) View Source

See Ashton.Doc.document/1.

Link to this function

document(schema, opts) View Source

See Ashton.Doc.document/2

Link to this function

merge(left, right) View Source

See Ashton.Schema.merge/2

Link to this function

merge(left, right, opts) View Source

See Ashton.Schema.merge/3.

Link to this function

schema() View Source

See Ashton.Schema.new/0.

Link to this function

schema(opts) View Source

See Ashton.Schema.new/1

Link to this function

validate(opts, schema) View Source 
validate(opts :: Keyword.t(), schema :: Ashton.Schema.t()) ::
  {:ok, Keyword.t()} | {:error, [error()]}

Link to this function

validate!(opts, schema) View Source 
validate!(opts :: Keyword.t(), schema :: schema()) :: Keyword.t() | no_return()

Validates opts according to a schema or the constructor for a schema. Raises on invalid opts.

iex> Ashton.validate!([reticulate_splines?: true], opts: [:reticulate_splines?])
[reticulate_splines?: true]
iex> Ashton.validate!([reticulate_splines?: true], opts: [:load_textures?], extra_keys?: true)
[reticulate_splines?: true]
iex> schema = Ashton.schema(opts: [:reticulate_splines?], required: [:reticulate_splines?], extra_keys?: true)
...> Ashton.validate!([reticulate_splines?: true, hack_interwebs?: true], schema)
[reticulate_splines?: true, hack_interwebs?: true]
iex> Ashton.validate!([], opts: [:reticulate_splines?], required: [:reticulate_splines?])
** (ArgumentError) Opt Validation Error: reticulate_splines? - is required