feat: add applyEllipsisOnLength

src/index.ts

@@ -286,3 +286,8 @@ export {
   type ChatBotMessage,
   GPTVersion,
 } from './chatbot/chatbot.js';
+
+/**
+ * string utils
+ */
+export * from './string/string.js';

src/string/string.test.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from 'vitest';
+
+import { applyEllipsisOnLength } from './string.js';
+
+describe('applyEllipsisOnLength', () => {
+  it('does not add ellipsis', () => {
+    expect(applyEllipsisOnLength('mystring', 100)).toEqual('mystring');
+    expect(applyEllipsisOnLength('my very long string is here', 100)).toEqual(
+      'my very long string is here',
+    );
+  });
+  it('add ellipsis', () => {
+    expect(applyEllipsisOnLength('mystring', 2)).toEqual('my…');
+    expect(applyEllipsisOnLength('my very long string is here', 10)).toEqual(
+      'my very lo…',
+    );
+  });
+});

src/string/string.ts

@@ -0,0 +1,14 @@
+/**
+ * add ellipsis on string given length
+ * warning: use css instead of this function if possible
+ * @param {any} longString:string
+ * @param {any} maxLength:number
+ * @returns {any}
+ */
+export const applyEllipsisOnLength = (
+  longString: string,
+  maxLength: number,
+): string =>
+  `${longString.slice(0, maxLength)}${
+    (longString.length || 0) > maxLength ? '…' : ''
+  }`;