Add support for passing VFileMessage to message in types

vfile · Nov 17, 2022 · db8c841 · db8c841
1 parent 0f72e1d
commit db8c841
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -309,7 +309,7 @@ export class VFile {
    * associates it with the file by adding it to `vfile.messages` and setting
    * `message.file` to the current filepath.
    *
-   * @param {string|Error} reason
+   * @param {string|Error|VFileMessage} reason
    *   Human readable reason for the message, uses the stack and message of the error if given.
    * @param {Node|NodeLike|Position|Point} [place]
    *   Place where the message occurred in the file.
@@ -337,7 +337,7 @@ export class VFile {
    * Like `VFile#message()`, but associates an informational message where
    * `fatal` is set to `null`.
    *
-   * @param {string|Error} reason
+   * @param {string|Error|VFileMessage} reason
    *   Human readable reason for the message, uses the stack and message of the error if given.
    * @param {Node|NodeLike|Position|Point} [place]
    *   Place where the message occurred in the file.
@@ -360,7 +360,7 @@ export class VFile {
    *
    * > 👉 **Note**: a fatal error means that a file is no longer processable.
    *
-   * @param {string|Error} reason
+   * @param {string|Error|VFileMessage} reason
    *   Human readable reason for the message, uses the stack and message of the error if given.
    * @param {Node|NodeLike|Position|Point} [place]
    *   Place where the message occurred in the file.