shelving 1.60.0 → 1.61.0

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.60.0",
+	"version": "1.61.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/util/string.d.ts

@@ -81,3 +81,9 @@ export declare function yieldWords(value: string): Generator<string, void, void>
 export declare const isUppercaseLetter: (str: string) => boolean;
 /** Is the first character of a string a lowercase letter? */
 export declare const isLowercaseLetter: (str: string) => boolean;
+/**
+ * Limit a string to a given length.
+ * - Stops at the last space inside `maxLength`
+ * - Appends an `…` ellipses after the string (but only if a limit is applied).
+ */
+export declare function limitString(str: string, maxLength: number, append?: string): string;

package/util/string.js

@@ -139,3 +139,14 @@ const MATCH_WORD = /[^\s"]+|"([^"]*)"/g; // Runs of characters without spaces, o
 export const isUppercaseLetter = (str) => isBetween(str.charCodeAt(0), 65, 90);
 /** Is the first character of a string a lowercase letter? */
 export const isLowercaseLetter = (str) => isBetween(str.charCodeAt(0), 97, 122);
+/**
+ * Limit a string to a given length.
+ * - Stops at the last space inside `maxLength`
+ * - Appends an `…` ellipses after the string (but only if a limit is applied).
+ */
+export function limitString(str, maxLength, append = "…") {
+    if (str.length < maxLength)
+        return str;
+    const lastSpace = str.lastIndexOf(" ", maxLength);
+    return `${str.slice(0, lastSpace > 0 ? lastSpace : maxLength).trimEnd()}${append}`;
+}