Figler.Scene.Options (figler v0.1.0-beta.1)

Copy Markdown View Source

Validation and types for public scene query and tree options.

Invalid options raise Figler.Error with code :invalid_options and structured errors under error.context.errors.

Summary

Types

fields()
find_option()
option_error()
query_option()
tree_option()

Types

fields()

@type fields() :: :all | [atom() | String.t()]

find_option()

@type find_option() ::
  {:type, atom() | String.t()}
  | {:name, String.t()}
  | {:name_contains, String.t()}
  | {:text_contains, String.t()}

option_error()

@type option_error() :: Figler.OptionError.t()

query_option()

@type query_option() :: {:fields, fields()}

tree_option()

@type tree_option() :: {:root, String.t()} | {:depth, non_neg_integer()}