diff --git a/documentation/dsls/DSL:-Reactor.cheatmd b/documentation/dsls/DSL:-Reactor.cheatmd index 285ec7c..19e4014 100644 --- a/documentation/dsls/DSL:-Reactor.cheatmd +++ b/documentation/dsls/DSL:-Reactor.cheatmd @@ -92,8 +92,7 @@ Wrap a function around a group of steps. - -### Options +### Arguments @@ -107,7 +106,7 @@ Wrap a function around a group of steps. - + +
- + name @@ -129,7 +128,7 @@ Wrap a function around a group of steps.
- + fun @@ -149,9 +148,23 @@ Wrap a function around a group of steps.
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + allow_async? @@ -225,8 +238,7 @@ argument :three, value(3) - -### Options +### Arguments @@ -240,7 +252,7 @@ argument :three, value(3) - + +
- + name @@ -262,7 +274,7 @@ argument :three, value(3)
- + source @@ -282,9 +294,23 @@ argument :three, value(3)
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + transform @@ -334,8 +360,7 @@ wait_for :create_user - -### Options +### Arguments @@ -349,7 +374,7 @@ wait_for :create_user
- + names @@ -376,6 +401,7 @@ wait_for :create_user + ### Introspection Target: `Reactor.Dsl.WaitFor` @@ -418,8 +444,7 @@ end - -### Options +### Arguments @@ -433,7 +458,7 @@ end - + +
- + name @@ -453,9 +478,23 @@ end
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + transform @@ -529,8 +568,7 @@ argument :three, value(3) - -### Options +### Arguments @@ -544,7 +582,7 @@ argument :three, value(3) - + +
- + name @@ -566,7 +604,7 @@ argument :three, value(3)
- + source @@ -586,9 +624,23 @@ argument :three, value(3)
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + transform @@ -638,8 +690,7 @@ wait_for :create_user - -### Options +### Arguments @@ -653,7 +704,7 @@ wait_for :create_user - -
- + names @@ -680,6 +731,7 @@ wait_for :create_user + ### Introspection Target: `Reactor.Dsl.WaitFor` @@ -723,58 +775,44 @@ Allows place another Reactor into this one as if it were a single step.
- + - reactor + name * - Reactor | module + atom - The reactor module or struct to compose upon. + A unique name for the step. Allows the result of the composed reactor to be depended upon by steps in this reactor.
-### Options - - - - - - - - - - - - + @@ -783,6 +821,7 @@ Allows place another Reactor into this one as if it were a single step.
NameTypeDefaultDocs
- + - name + reactor * - atom + Reactor | module - A unique name for the step. Allows the result of the composed reactor to be depended upon by steps in this reactor. + The reactor module or struct to compose upon.
+ ## reactor.compose.argument ```elixir argument name, source \ nil @@ -834,8 +873,7 @@ argument :three, value(3) - -### Options +### Arguments @@ -849,7 +887,7 @@ argument :three, value(3) - + +
- + name @@ -871,7 +909,7 @@ argument :three, value(3)
- + source @@ -891,9 +929,23 @@ argument :three, value(3)
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + transform @@ -943,8 +995,7 @@ wait_for :create_user - -### Options +### Arguments @@ -958,7 +1009,7 @@ wait_for :create_user
- + names @@ -985,6 +1036,7 @@ wait_for :create_user + ### Introspection Target: `Reactor.Dsl.WaitFor` @@ -1020,8 +1072,7 @@ end - -### Options +### Arguments @@ -1035,7 +1086,7 @@ end - + +
- + name @@ -1055,9 +1106,23 @@ end
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + level @@ -1131,8 +1196,7 @@ argument :three, value(3) - -### Options +### Arguments @@ -1146,7 +1210,7 @@ argument :three, value(3) - + +
- + name @@ -1168,7 +1232,7 @@ argument :three, value(3)
- + source @@ -1188,9 +1252,23 @@ argument :three, value(3)
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + transform @@ -1240,8 +1318,7 @@ wait_for :create_user - -### Options +### Arguments @@ -1255,7 +1332,7 @@ wait_for :create_user
- + names @@ -1282,6 +1359,7 @@ wait_for :create_user + ### Introspection Target: `Reactor.Dsl.WaitFor` @@ -1309,8 +1387,7 @@ Call functions before and after a group of steps. - -### Options +### Arguments @@ -1324,7 +1401,7 @@ Call functions before and after a group of steps. - + +
- + name @@ -1344,9 +1421,23 @@ Call functions before and after a group of steps.
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + before_all @@ -1368,7 +1459,7 @@ Call functions before and after a group of steps.
- + after_all @@ -1390,7 +1481,7 @@ Call functions before and after a group of steps.
- + allow_async? @@ -1464,8 +1555,7 @@ argument :three, value(3) - -### Options +### Arguments @@ -1479,7 +1569,7 @@ argument :three, value(3) - + +
- + name @@ -1501,7 +1591,7 @@ argument :three, value(3)
- + source @@ -1521,9 +1611,23 @@ argument :three, value(3)
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + transform @@ -1573,8 +1677,7 @@ wait_for :create_user - -### Options +### Arguments @@ -1588,7 +1691,7 @@ wait_for :create_user
- + names @@ -1615,6 +1718,7 @@ wait_for :create_user + ### Introspection Target: `Reactor.Dsl.WaitFor` @@ -1658,8 +1762,7 @@ end - -### Options +### Arguments @@ -1673,7 +1776,7 @@ end - + +
- + name @@ -1693,9 +1796,23 @@ end
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + transform @@ -1767,8 +1884,7 @@ end - -### Options +### Arguments @@ -1782,7 +1898,7 @@ end - + +
- + name @@ -1804,7 +1920,7 @@ end
- + impl @@ -1823,9 +1939,23 @@ end
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + run @@ -1846,7 +1976,7 @@ end
- + undo @@ -1867,7 +1997,7 @@ end
- + compensate @@ -1888,7 +2018,7 @@ end
- + max_retries @@ -1909,7 +2039,7 @@ end
- + async? @@ -1930,7 +2060,7 @@ end
- + transform @@ -2004,8 +2134,7 @@ argument :three, value(3) - -### Options +### Arguments @@ -2019,7 +2148,7 @@ argument :three, value(3) - + +
- + name @@ -2041,7 +2170,7 @@ argument :three, value(3)
- + source @@ -2061,9 +2190,23 @@ argument :three, value(3)
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + transform @@ -2113,8 +2256,7 @@ wait_for :create_user - -### Options +### Arguments @@ -2128,7 +2270,7 @@ wait_for :create_user
- + names @@ -2155,6 +2297,7 @@ wait_for :create_user + ### Introspection Target: `Reactor.Dsl.WaitFor` @@ -2184,8 +2327,7 @@ Use a predicate to determine which steps should be executed. - -### Options +### Arguments @@ -2199,7 +2341,7 @@ Use a predicate to determine which steps should be executed. - + +
- + name @@ -2219,9 +2361,23 @@ Use a predicate to determine which steps should be executed.
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + on @@ -2243,7 +2399,7 @@ Use a predicate to determine which steps should be executed.
- + allow_async? @@ -2279,8 +2435,7 @@ A group of steps to run when the predicate matches. - -### Options +### Arguments @@ -2294,7 +2449,7 @@ A group of steps to run when the predicate matches. - + +
- + predicate @@ -2314,9 +2469,23 @@ A group of steps to run when the predicate matches.
+### Options + + + + + + + + + + + +
NameTypeDefaultDocs
- + allow_async? @@ -2337,7 +2506,7 @@ A group of steps to run when the predicate matches.
- + return @@ -2393,7 +2562,7 @@ steps will be run if provided.
- + return diff --git a/mix.lock b/mix.lock index 547b768..a89670d 100644 --- a/mix.lock +++ b/mix.lock @@ -23,7 +23,7 @@ "nimble_parsec": {:hex, :nimble_parsec, "1.3.1", "2c54013ecf170e249e9291ed0a62e5832f70a476c61da16f6aac6dca0189f2af", [:mix], [], "hexpm", "2682e3c0b2eb58d90c6375fc0cc30bc7be06f365bf72608804fb9cffa5e1b167"}, "sobelow": {:hex, :sobelow, "0.13.0", "218afe9075904793f5c64b8837cc356e493d88fddde126a463839351870b8d1e", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "cd6e9026b85fc35d7529da14f95e85a078d9dd1907a9097b3ba6ac7ebbe34a0d"}, "sourceror": {:hex, :sourceror, "0.14.0", "b6b8552d0240400d66b6f107c1bab7ac1726e998efc797f178b7b517e928e314", [:mix], [], "hexpm", "809c71270ad48092d40bbe251a133e49ae229433ce103f762a2373b7a10a8d8b"}, - "spark": {:hex, :spark, "1.1.43", "5817cefa41c6f7105989fa40c044c05bf2cab7b81c8ecbd963bdbdf6eeabc85a", [:mix], [{:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.5 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:sourceror, "~> 0.1", [hex: :sourceror, repo: "hexpm", optional: false]}], "hexpm", "29e42b900f3a7666e67fba270ff10d7b9fc693c8c2179b6bd65aa6b8426d30ca"}, + "spark": {:hex, :spark, "1.1.44", "be9f2669b03ae43447bda77045598a4500988538a7d0ba576b8e306332822147", [:mix], [{:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.5 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:sourceror, "~> 0.1", [hex: :sourceror, repo: "hexpm", optional: false]}], "hexpm", "e49bf5ca770cb0bb9cac7ed8da5eb7871156b3236c8c535f3f4caa93377059a3"}, "yamerl": {:hex, :yamerl, "0.10.0", "4ff81fee2f1f6a46f1700c0d880b24d193ddb74bd14ef42cb0bcf46e81ef2f8e", [:rebar3], [], "hexpm", "346adb2963f1051dc837a2364e4acf6eb7d80097c0f53cbdc3046ec8ec4b4e6e"}, "yaml_elixir": {:hex, :yaml_elixir, "2.9.0", "9a256da867b37b8d2c1ffd5d9de373a4fda77a32a45b452f1708508ba7bbcb53", [:mix], [{:yamerl, "~> 0.10", [hex: :yamerl, repo: "hexpm", optional: false]}], "hexpm", "0cb0e7d4c56f5e99a6253ed1a670ed0e39c13fc45a6da054033928607ac08dfc"}, }