Confispex.Type.Integer (confispex v1.1.0)

An integer type.

Casts input string to Integer.

Options

  • :scope - can be :positive, requires parsed integer value to be > 0

Examples

iex> Confispex.Type.cast("-42", Confispex.Type.Integer)
{:ok, -42}

iex> Confispex.Type.cast("-42", {Confispex.Type.Integer, scope: :positive})
{:error, {"-42", {Confispex.Type.Integer, [scope: :positive]}, [validation: "expected a positive integer"]}}

iex> Confispex.Type.cast("42 monkeys", Confispex.Type.Integer)
{:error,
 {"42 monkeys", Confispex.Type.Integer,
  [parsing: ["unexpected substring ", {:highlight, ~s|" monkeys"|}]]}}