docs(string): add truncateMiddle examples

Author: unrevised6419

src/string.ts

@@ -44,12 +44,16 @@ export function initials(name: Maybe<string>): Optional<string> {
  * There are cases where important information is at the end of the string and truncating the end isn't helpful.
  * This function solves that.
  *
+ * @example
+ * ```ts
+ * truncateMiddle('very-long-file-name.txt', 10, 4); // 'very-long&hellip;name.txt'
+ * truncateMiddle('Hello, world!', 5, 6); // 'Hello&hellip;world!'
+ * truncateMiddle('Hello, world!', 5, 0); // 'Hello&hellip;'
+ * truncateMiddle('Hello, world!', 0, 6); // '&hellip;world!'
+ * truncateMiddle('Hello, world!', 0, 0); // 'Hello, world!'
+ * ```
+ *
  * @license https://github.com/kahwee/truncate-middle#license
- * @param str - String to be truncated
- * @param frontLen - Number of characters to be remained in front
- * @param backLen - Number of characters to be remained at the back
- * @param truncateStr - String that replaces the truncated portion
- * @returns Truncated string. Defaults to '&hellip;' if unspecified
  */
 export function truncateMiddle(
 	str: Maybe<string>,