From 4651e08553c1c2d3340dc9ea16f5375292bf892d Mon Sep 17 00:00:00 2001 From: Shadowfacts Date: Sat, 2 Nov 2019 03:06:44 +0000 Subject: [PATCH] Update page 'Conditional Stage' --- Conditional-Stage.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 Conditional-Stage.md diff --git a/Conditional-Stage.md b/Conditional-Stage.md new file mode 100644 index 0000000..647bcf7 --- /dev/null +++ b/Conditional-Stage.md @@ -0,0 +1,12 @@ +The Conditional pipeline stage allows another pipeline stage to be applied if the RSS item matches the given condition. + +The options for the Conditional stage are: + +### `condition` +The condition that each RSS item must match for the other pipeline stage to be applied. This can either be a full Filter object or a single Rule object, both of which are described [here](https://git.shadowfacts.net/shadowfacts/frenzy/wiki/Filtering). + +### `stage` +A string containing the module name of the pipeline stage that should be applied if the `condition` matches an RSS item. + +### `opts` +An object containing the options to provide to the other pipeline stage. \ No newline at end of file