feat(utils): trim, trimEnd, trimStart

Signed-off-by: Lexus Drumgold <[email protected]>

src/types/__tests__/trim-end.spec-d.ts

@@ -6,7 +6,7 @@
 import type TestSubject from '../trim-end'
 
 describe('unit-d:types/TrimEnd', () => {
-  it('should remove trailing whitespaces from T', () => {
+  it('should return T without trailing whitespaces', () => {
     expectTypeOf<TestSubject<' foo '>>().toEqualTypeOf<' foo'>()
   })
 })

src/types/__tests__/trim-start.spec-d.ts

@@ -6,7 +6,7 @@
 import type TestSubject from '../trim-start'
 
 describe('unit-d:types/TrimStart', () => {
-  it('should remove leading whitespaces from T', () => {
-    expectTypeOf<TestSubject<' foo '>>().toEqualTypeOf<'foo '>()
+  it('should return T without leading whitespaces', () => {
+    expectTypeOf<TestSubject<' bar '>>().toEqualTypeOf<'bar '>()
   })
 })

src/types/__tests__/trim.spec-d.ts

@@ -6,7 +6,7 @@
 import type TestSubject from '../trim'
 
 describe('unit-d:types/Trim', () => {
-  it('should remove leading and trailing whitespaces from T', () => {
-    expectTypeOf<TestSubject<' foo '>>().toEqualTypeOf<'foo'>()
+  it('should return T without leading and trailing whitespaces', () => {
+    expectTypeOf<TestSubject<' baz '>>().toEqualTypeOf<'baz'>()
   })
 })

src/utils/__tests__/trim-end.spec-d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Type Tests - trimEnd
+ * @module tutils/utils/tests/unit-d/trimEnd
+ */
+
+import type { TrimEnd } from '#src/types'
+import type testSubject from '../trim-end'
+
+describe('unit-d:utils/trimEnd', () => {
+  it('should return TrimEnd<T>', () => {
+    // Arrange
+    type T = 'foo '
+
+    // Expect
+    expectTypeOf<typeof testSubject<T>>().returns.toEqualTypeOf<TrimEnd<T>>()
+  })
+})

src/utils/__tests__/trim-end.spec.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Unit Tests - trimEnd
+ * @module tutils/utils/tests/unit/trimEnd
+ */
+
+import testSubject from '../trim-end'
+
+describe('unit:utils/trimEnd', () => {
+  it('should return string without trailing whitespaces', () => {
+    // Arrange
+    const string: string = 'foo '
+
+    // Act + Expect
+    expect(testSubject(string)).to.equal(string.trimEnd())
+  })
+})

src/utils/__tests__/trim-start.spec-d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Type Tests - trimStart
+ * @module tutils/utils/tests/unit-d/trimStart
+ */
+
+import type { TrimStart } from '#src/types'
+import type testSubject from '../trim-start'
+
+describe('unit-d:utils/trimStart', () => {
+  it('should return TrimStart<T>', () => {
+    // Arrange
+    type T = ' bar'
+
+    // Expect
+    expectTypeOf<typeof testSubject<T>>().returns.toEqualTypeOf<TrimStart<T>>()
+  })
+})

src/utils/__tests__/trim-start.spec.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Unit Tests - trimStart
+ * @module tutils/utils/tests/unit/trimStart
+ */
+
+import testSubject from '../trim-start'
+
+describe('unit:utils/trimStart', () => {
+  it('should return string without leading whitespaces', () => {
+    // Arrange
+    const string: string = ' bar'
+
+    // Act + Expect
+    expect(testSubject(string)).to.equal(string.trimStart())
+  })
+})

src/utils/__tests__/trim.spec-d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Type Tests - trim
+ * @module tutils/utils/tests/unit-d/trim
+ */
+
+import type { Trim } from '#src/types'
+import type testSubject from '../trim'
+
+describe('unit-d:utils/trim', () => {
+  it('should return Trim<T>', () => {
+    // Arrange
+    type T = ' baz '
+
+    // Expect
+    expectTypeOf<typeof testSubject<T>>().returns.toEqualTypeOf<Trim<T>>()
+  })
+})

src/utils/__tests__/trim.spec.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Unit Tests - trim
+ * @module tutils/utils/tests/unit/trim
+ */
+
+import testSubject from '../trim'
+
+describe('unit:utils/trim', () => {
+  it('should return string without leading and trailing whitespaces', () => {
+    // Arrange
+    const string: string = ' baz '
+
+    // Act + Expect
+    expect(testSubject(string)).to.equal(string.trim())
+  })
+})

src/utils/index.ts

@@ -24,4 +24,7 @@ export { default as isSymbol } from './is-symbol'
 export { default as isUndefined } from './is-undefined'
 export { default as isUppercase } from './is-uppercase'
 export { default as lowercase } from './lowercase'
+export { default as trim } from './trim'
+export { default as trimEnd } from './trim-end'
+export { default as trimStart } from './trim-start'
 export { default as uppercase } from './uppercase'

src/utils/trim-end.ts

@@ -0,0 +1,22 @@
+/**
+ * @file Utilities - trimEnd
+ * @module tutils/utils/trimEnd
+ */
+
+import type { TrimEnd } from '#src/types'
+
+/**
+ * Removes trailing whitespace characters from `string`.
+ *
+ * @see {@linkcode TrimEnd}
+ *
+ * @template T - String to trim
+ *
+ * @param {T} string - String to trim
+ * @return {TrimEnd<T>} `string` with trailing whitespaces removed
+ */
+function trimEnd<T extends string>(string: T): TrimEnd<T> {
+  return string.trimEnd<T>()
+}
+
+export default trimEnd

src/utils/trim-start.ts

@@ -0,0 +1,22 @@
+/**
+ * @file Utilities - trimStart
+ * @module tutils/utils/trimStart
+ */
+
+import type { TrimStart } from '#src/types'
+
+/**
+ * Removes leading whitespace characters from `string`.
+ *
+ * @see {@linkcode TrimStart}
+ *
+ * @template T - String to trim
+ *
+ * @param {T} string - String to trim
+ * @return {TrimStart<T>} `string` with leading whitespaces removed
+ */
+function trimStart<T extends string>(string: T): TrimStart<T> {
+  return string.trimStart<T>()
+}
+
+export default trimStart

src/utils/trim.ts

@@ -0,0 +1,22 @@
+/**
+ * @file Utilities - trim
+ * @module tutils/utils/trim
+ */
+
+import type { Trim } from '#src/types'
+
+/**
+ * Removes leading and trailing whitespace characters from `string`.
+ *
+ * @see {@linkcode Trim}
+ *
+ * @template T - String to trim
+ *
+ * @param {T} string - String to trim
+ * @return {Trim<T>} `string` with leading and trailing whitespaces removed
+ */
+function trim<T extends string>(string: T): Trim<T> {
+  return string.trim<T>()
+}
+
+export default trim

typings/typescript/lib/lib.es5.d.ts

@@ -1,4 +1,9 @@
-import type { OneOrMany } from '@flex-development/tutils'
+import type {
+  OneOrMany,
+  Trim,
+  TrimEnd,
+  TrimStart
+} from '@flex-development/tutils'
 
 declare global {
   interface String {
@@ -45,5 +50,32 @@ declare global {
      * @return {Uppercase<T>} Uppercase string
      */
     toUpperCase<T extends string>(): Uppercase<T>
+
+    /**
+     * Removes leading and trailing whitespace characters from a string.
+     *
+     * @template T - String being trimmed
+     *
+     * @return {Trim<T>} String with leading and trailing whitespaces removed
+     */
+    trim<T extends string>(): Trim<T>
+
+    /**
+     * Removes trailing whitespace characters from a string.
+     *
+     * @template T - String being trimmed
+     *
+     * @return {TrimEnd<T>} String with trailing whitespaces removed
+     */
+    trimEnd<T extends string>(): TrimEnd<T>
+
+    /**
+     * Removes leading whitespace characters from a string.
+     *
+     * @template T - String being trimmed
+     *
+     * @return {TrimStart<T>} String with leading whitespaces removed
+     */
+    trimStart<T extends string>(): TrimStart<T>
   }
 }