Added simple string truncate with ellipsis method

Author: jamesmcroft

MADE.Data.Converters/src/string/index.ts

@@ -1,3 +1,18 @@
+/**
+ * Truncates a string value to the specified length with an ellipsis.
+ * @param {string} value - The value to truncate.
+ * @param {number} maxLength - The maximum length of the value.
+ * @return {string} A truncated string with ellipsis if the value's length is greater than the max length.
+ */
+export function truncate(value: string, maxLength: number): string {
+    if (isNullOrWhiteSpace(value) || value.length <= maxLength) {
+        return value;
+    }
+
+    const suffix = "...";
+    return value.substring(0, maxLength - suffix.length) + suffix;
+}
+
 /**
  * Converts a string value to a number value.
  * @param {string} value - The string value to convert.

MADE.Data.Converters/tests/string/truncate.spec.ts

@@ -0,0 +1,25 @@
+import { truncate } from '../../src'
+
+describe("when truncating a string", () => {
+    it("should return a truncated string if greater than max length", () => {
+        // Arrange
+        const input = "Hello, World!"
+
+        // Act
+        const result = truncate(input, 8);
+
+        // Assert
+        expect(result).toBe("Hello...");
+    });
+
+    it("should return original string if less than max length", () => {
+        // Arrange
+        const input = "Hello, World!"
+
+        // Act
+        const result = truncate(input, input.length);
+
+        // Assert
+        expect(result).toBe(input);
+    });
+});