Update api docs

bluwy · Jan 11, 2023 · 2cb06d9 · 2cb06d9
1 parent 6bde9d5
commit 2cb06d9
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/pkg/README.md b/pkg/README.md
@@ -54,7 +54,14 @@ const messages = await publint({
    * A virtual file-system object that handles fs/path operations.
    * This field is required if you're using in the browser.
    */
-  vfs: createCustomVfsObj()
+  vfs: createCustomVfsObj(),
+  /**
+   * The level of messages to log (default: `'suggestion'`).
+   * - `suggestion`: logs all messages
+   * - `warning`: logs only `warning` and `error` messages
+   * - `error`: logs only `error` messages
+   */
+  level: 'warning'
 })
 
 console.log(messages)