Update page 'Conditional Stage'

Shadowfacts 2019-11-02 03:06:44 +00:00
parent 14a09be8f5
commit 4651e08553
1 changed files with 12 additions and 0 deletions

12
Conditional-Stage.md Normal file

@ -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.