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

Validation and types for the public effective-graph option contract.

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

Summary

Types

build_option()

option_error()

stage()

Functions

stages()

Returns the supported resolver stages in execution order.

Types

build_option()

@type build_option() ::
  {:stages, stage() | [stage()]}
  | {:only, stage() | [stage()]}
  | {:until, stage()}
  | {:skip, stage() | [stage()]}
  | {:focus,
     String.t()
     | Figler.Scene.Graph.GUID.graph_guid()
     | [String.t() | Figler.Scene.Graph.GUID.graph_guid()]}
  | {:root, String.t() | Figler.Scene.Graph.GUID.graph_guid()}
  | {:resolve_variables, false | :known | :preserve}
  | {:resolve_styles, false | :refs | :known}
  | {:fields, :all | [atom() | String.t()]}

option_error()

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

stage()

@type stage() ::
  :populate_instances
  | :symbol_overrides
  | :sync_overrides
  | :component_props
  | :sync_component_props
  | :derived_symbol_data
  | :stack_layout
  | :variables

Functions

stages()

@spec stages() :: [stage()]

Returns the supported resolver stages in execution order.