View Source Pipeline.Types (ex_pipeline v0.2.0)

Shared type definitions for all modules

Link to this section Summary

Types

The arguments that are used by the first step of a pipeline and well - the initial state of the pipeline.

A function that is always called after the pipeline finishes the execution, but asynchronously.

A function that is always called after the pipeline finishes the execution.

The optional arguments that are passed to steps and callbacks of a pipeline.

A function that transforms a value into something else.

The result of the execution of a step or the final result of an entire pipeline.

Link to this section Types

@type args() :: any()

The arguments that are used by the first step of a pipeline and well - the initial state of the pipeline.

@type async_hook() :: hook()

A function that is always called after the pipeline finishes the execution, but asynchronously.

@type hook() :: (Pipeline.State.t(), options() -> any())

A function that is always called after the pipeline finishes the execution.

@type options() :: Keyword.t()

The optional arguments that are passed to steps and callbacks of a pipeline.

@type reducer() :: (args(), options() -> result())

A function that transforms a value into something else.

@type result() :: {:ok, any()} | {:error, any()}

The result of the execution of a step or the final result of an entire pipeline.