conform

v2.5.2

conform v2.5.2 Conform.Types.Enum

Custom type for enumerations, i.e. [:a, :b, :c]

Usage 

[ mapping: [
  "foo.bar": [
    datatype: [Conform.Types.Enum: [:a, :b, :c]],
    default: :a,
    ...
  ]]]

Summary

Functions

convert(value, mapping)

Converts the .conf value to this data type. Should return the translated value or {:error, reason}

to_doc(values)

Return a string to produce documentation for the given type based on it’s valid values (if specified). If nil is returned, the documentation specified in the schema will be used instead (if present)

Functions

convert(value, mapping)

Converts the .conf value to this data type. Should return the translated value or {:error, reason}

Callback implementation for Conform.Type.convert/2.

to_doc(values)

Return a string to produce documentation for the given type based on it’s valid values (if specified). If nil is returned, the documentation specified in the schema will be used instead (if present).

Callback implementation for Conform.Type.to_doc/1.