Update documentation

ehmicky · Nov 20, 2022 · 30bb95a · 30bb95a
1 parent b6f7c2e
commit 30bb95a
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/types/main.d.ts b/types/main.d.ts
@@ -1,9 +1,36 @@
 type NormalizeError<ErrorArg> = ErrorArg extends Error ? ErrorArg : Error
 
 /**
+ * Appends `message` to `error.message`. If `message` ends with `:` or `:\n`,
+ * prepends it instead.
+ *
+ * Returns `error`. If `error` is not an `Error` instance, it is converted to
+ * one.
  *
  * @example
  * ```js
+ * wrapErrorMessage(new Error('Message.'), 'Additional message.')
+ * // Error: Message.
+ * // Additional message.
+ *
+ * wrapErrorMessage(new Error('Message.'), 'Additional message:')
+ * // Error: Additional message: Message.
+ *
+ * wrapErrorMessage(new Error('Message.'), 'Additional message:\n')
+ * // Error: Additional message:
+ * // Message.
+ *
+ * wrapErrorMessage(new Error('Message.'), '')
+ * // Error: Message.
+ *
+ * const invalidError = 'Message.'
+ * wrapErrorMessage(invalidError, 'Additional message.')
+ * // Error: Message.
+ * // Additional message.
+ *
+ * wrapErrorMessage(new Error('  Message with spaces  '), '  Additional message  ')
+ * // Error: Message with spaces
+ * // Additional message
  * ```
  */
 export default function wrapErrorMessage<ErrorArg>(