example

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-08-28 15:44:27 +02:00
parent 5bbd0708f6
commit 35173ddb33
1 changed files with 7 additions and 0 deletions
@@ -150,6 +150,13 @@ export interface Config {
     *
     * @remarks
     *
+     * Example:
+     *
+     * ```yaml
+     * catalog:
+     *   processingInterval: { minutes: 30 }
+     * ```
+     *
     * Note that this is only a suggested minimum, and the actual interval may
     * be longer. Internally, the catalog will scale up this number by a small
     * factor and choose random numbers in that range to spread out the load. If