Skip to content

Commit

Permalink
docs: improve ProcessingStage description
Browse files Browse the repository at this point in the history
  • Loading branch information
ahochsteger committed Sep 3, 2023
1 parent 2c12656 commit 7a868f9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/reference-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The following table lists all enum types and their values referenced in the conf
| <a id="enum.MessageFlag">`MessageFlag`</a> | A flag to match messages with certain properties. | <ul><li><a id="enum.MessageFlag.read">`read`</a>: Matches read messages.</li><li><a id="enum.MessageFlag.starred">`starred`</a>: Matches starred messages.</li><li><a id="enum.MessageFlag.unread">`unread`</a>: Matches unread messages.</li><li><a id="enum.MessageFlag.unstarred">`unstarred`</a>: Matches unstarred messages.</li></ul> |
| <a id="enum.MetaInfoType">`MetaInfoType`</a> | The type of meta information used for context substitution placerholders. | <ul><li><a id="enum.MetaInfoType.boolean">`boolean`</a>: Boolean type substituted to `true` or `false`.</li><li><a id="enum.MetaInfoType.date">`date`</a>: Date/time type. For substitution a format string can be given using `${<placeholder>:format:<formatstring>}`.</li><li><a id="enum.MetaInfoType.number">`number`</a>: A numeric data type.</li><li><a id="enum.MetaInfoType.string">`string`</a>: A string data type.</li><li><a id="enum.MetaInfoType.variable">`variable`</a>: A custom configuration variable.</li></ul> |
| <a id="enum.PlaceholderType">`PlaceholderType`</a> | The type of a placeholder. | <ul><li><a id="enum.PlaceholderType.attachment">`attachment`</a>: An attachment placeholder type.</li><li><a id="enum.PlaceholderType.message">`message`</a>: A message placeholder type.</li><li><a id="enum.PlaceholderType.thread">`thread`</a>: A thread placeholder type.</li></ul> |
| <a id="enum.ProcessingStage">`ProcessingStage`</a> | The stage of processing | <ul><li><a id="enum.ProcessingStage.main">`main`</a>: The stage during processing the main object (thread, message, attachment)</li><li><a id="enum.ProcessingStage.post-main">`post-main`</a>: The stage after processing the main object (thread, message, attachment)</li><li><a id="enum.ProcessingStage.pre-main">`pre-main`</a>: The stage before processing the main object (thread, message, attachment)</li></ul> |
| <a id="enum.ProcessingStage">`ProcessingStage`</a> | The stage of action processing | <ul><li><a id="enum.ProcessingStage.main">`main`</a>: The stage during processing the main object (thread, message, attachment)</li><li><a id="enum.ProcessingStage.post-main">`post-main`</a>: The stage after processing the main object (thread, message, attachment)</li><li><a id="enum.ProcessingStage.pre-main">`pre-main`</a>: The stage before processing the main object (thread, message, attachment)</li></ul> |
| <a id="enum.ProcessingStatus">`ProcessingStatus`</a> | The result status of processing a config or an action. | <ul><li><a id="enum.ProcessingStatus.error">`error`</a>: An error has occurred.</li><li><a id="enum.ProcessingStatus.ok">`ok`</a>: The processing was successful.</li></ul> |
| <a id="enum.RunMode">`RunMode`</a> | The runtime mode in which processing takes place. | <ul><li><a id="enum.RunMode.dangerous">`dangerous`</a>: This run-mode will execute all configured actions including possibly destructive actions like overwriting files or removing threads or messages.<br>ATTENTION: Use this only if you know exactly what you're doing and won't complain if something goes wrong!</li><li><a id="enum.RunMode.dry-run">`dry-run`</a>: This run-mode skips execution of writing actions. Use this for testing config changes or library upgrades.</li><li><a id="enum.RunMode.safe-mode">`safe-mode`</a>: This run-mode can be used for normal uperation but will skip possibly destructive actions like overwriting files or removing threads or messages.</li></ul> |

Expand Down
2 changes: 1 addition & 1 deletion src/lib/config/ActionConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { essentialObject } from "../utils/ConfigUtils"
import { RequiredDeep } from "../utils/UtilityTypes"

/**
* The stage of processing
* The stage of action processing
*/
export enum ProcessingStage {
/** The stage before processing the main object (thread, message, attachment) */
Expand Down

0 comments on commit 7a868f9

Please sign in to comment.