View Source Drops.Types.Map.DSL (drops v0.1.0)

DSL functions for defining map key and value type specifications.

Functions from this module are typically used via Drops.Contract.schema/1

Summary

Types

type()

Functions

any()

Returns :any type specification.

boolean()

Returns a boolean type specification.

cast(type, cast_opts \\ [])

Returns a type cast specification.

float()

Returns a float type specification.

float(predicates)

Returns a float type specification with additional constraints.

float(cast_spec, predicates \\ [])

integer()

Returns an integer type specification.

integer(predicate)

Returns an integer type specification with additional constraints.

integer(cast_spec, predicates \\ [])

list(members)

Returns a list type specification.

list(type, predicates \\ [])

Returns a list type specification with a constrained member type

map()

Returns a map type specification.

map(predicate)

Returns a map type specification with additional constraints.

maybe(schema)

Returns a maybe type specification.

maybe(type, predicates \\ [])

Returns a maybe type specification with additional constraints.

optional(name)

Returns an optional key specification.

required(name)

Returns a required key specification.

string()

Returns a string type specification.

string(predicate)

Returns a string type specification with additional constraints.

string(cast_spec, predicates \\ [])

type(type)

Returns a type specification.

type(type, predicates)

Returns a type specification with additional constraints.

Types

type()

@type type() :: {:type, {atom(), keyword()}}

Functions

any()

(since 0.1.0)

@spec any() :: type()

Returns :any type specification.

Examples

any()

boolean()

(since 0.1.0)

@spec boolean() :: type()

Returns a boolean type specification.

Examples

# a boolean with no constraints
boolean()

cast(type, cast_opts \\ [])

(since 0.1.0)

@spec cast(type(), Keyword.t()) :: {:cast, {type(), Keyword.t()}}

Returns a type cast specification.

Examples

# cast a string to an integer
cast(:string) |> integer()

# cast a string to an integer with additional constraints
cast(string(match?: ~r/\d+/])) |> integer()

float()

(since 0.1.0)

@spec float() :: type()

Returns a float type specification.

Examples

# a float with no constraints
float()

float(predicates)

(since 0.1.0)

@spec float([]) :: type()

Returns a float type specification with additional constraints.

Examples

# a float with constraints
float(gt?: 1.0)

float(cast_spec, predicates \\ [])

integer()

(since 0.1.0)

@spec integer() :: type()

Returns an integer type specification.

Examples

# an integer with no constraints
integer()

integer(predicate)

(since 0.1.0)

@spec integer(atom()) :: type()

@spec integer([]) :: type()

Returns an integer type specification with additional constraints.

Examples

# an integer with constraints
integer(:even?)

# an integer with multiple constraints
integer([:even?, gt?: 100])

integer(cast_spec, predicates \\ [])

list(members)

(since 0.1.0)

@spec list([atom()]) :: type()

@spec list([atom()]) :: type()

Returns a list type specification.

Examples

# a list with a specified member type
list(:string)

# a list with a specified sum member type
list([:string, :integer])

list(type, predicates \\ [])

(since 0.1.0)

Returns a list type specification with a constrained member type

Examples

# a list with a specified member type
list(:string, [:filled?])

list(:integer, [gt?: 18])

map()

(since 0.1.0)

@spec map() :: type()

Returns a map type specification.

Examples

# a map with no constraints
map()

map(predicate)

(since 0.1.0)

@spec map(atom()) :: type()

@spec map([]) :: type()

Returns a map type specification with additional constraints.

Examples

# a map with constraints
map(min_size?: 2)

maybe(schema)

(since 0.1.0)

@spec maybe(atom()) :: type()

@spec maybe(map()) :: [type()]

Returns a maybe type specification.

Examples

# either a nil or a string
maybe(:string)

maybe(type, predicates \\ [])

(since 0.1.0)

@spec maybe(atom(), []) :: type()

Returns a maybe type specification with additional constraints.

Examples

# either a nil or a non-empty string
maybe(:string, [:filled?])

optional(name)

(since 0.1.0)

@spec optional(atom()) :: {:optional, atom()}

Returns an optional key specification.

Examples

%{
  optional(:age) => type(:integer)
}

required(name)

(since 0.1.0)

@spec required(atom()) :: {:required, atom()}

Returns a required key specification.

Examples

%{
  required(:email) => type(:string)
}

string()

(since 0.1.0)

@spec string() :: type()

Returns a string type specification.

Examples

# a string with no constraints
string()

string(predicate)

(since 0.1.0)

@spec string(atom()) :: type()

@spec string([]) :: type()

Returns a string type specification with additional constraints.

Examples

# a string with constraints
string(:filled?)

# a string with multiple constraints
string([:filled?, max_length?: 255])

string(cast_spec, predicates \\ [])

type(type)

(since 0.1.0)

@spec type({atom(), []}) :: type()

@spec type([{:list, atom()}]) :: type()

@spec type([{:list, []}]) :: type()

@spec type([atom()]) :: [type()]

@spec type(atom()) :: type()

Returns a type specification.

Examples

# string
type(:string)

# either a nil or a string
type([:nil, :string])

type(type, predicates)

(since 0.1.0)

@spec type(atom(), []) :: type()

@spec type(
  {:cast, {atom(), []}},
  type()
) :: type()

Returns a type specification with additional constraints.

Examples

# string with that must be filled
type(:string, [:filled?]),

# an integer that must be greater than 18
type(:integer, [gt?: 18])

Settings View Source Drops.Types.Map.DSL (drops v0.1.0)

type()

any()

boolean()

cast(type, cast_opts \\ [])

float()

float(predicates)

float(cast_spec, predicates \\ [])

integer()

integer(predicate)

integer(cast_spec, predicates \\ [])

list(members)

list(type, predicates \\ [])

map()

map(predicate)

maybe(schema)

maybe(type, predicates \\ [])

optional(name)

required(name)

string()

string(predicate)

string(cast_spec, predicates \\ [])

type(type)

type(type, predicates)

View Source Drops.Types.Map.DSL (drops v0.1.0)