View Source ExConnpass (ex_connpass v0.2.0)

Link to this section Summary

Types

t()

Command struct.

Functions

Creates a new struct from given parameters.

Runs given pipelines in order and returns command struct.

Link to this section Types

Specs

t() :: %ExConnpass{
  data: map(),
  errors: map(),
  halted: boolean(),
  params: map(),
  pipelines: [Commandex.pipeline()],
  success: boolean()
}

Command struct.

Attributes

  • data - Data generated during the pipeline, defined by Commandex.data/1.
  • errors - Errors generated during the pipeline with Commandex.put_error/3
  • halted - Whether or not the pipeline was halted.
  • params - Parameters given to the command, defined by Commandex.param/1.
  • pipelines - A list of pipeline functions to execute, defined by Commandex.pipeline/1.
  • success - Whether or not the command was successful. This is only set to true if the command was not halted after running all of the pipelines.

Link to this section Functions

Link to this function

build_url(command, map, data)

View Source
Link to this function

call_api(command, params, map)

View Source
Link to this function

decode(command, map1, map2)

View Source

Specs

new(map() | Keyword.t()) :: t()

Creates a new struct from given parameters.

Specs

run(map() | Keyword.t() | t()) :: t()

Runs given pipelines in order and returns command struct.

run/1 can either take parameters that would be passed to new/1 or the command struct itself.