improve trim docs and tests (#225)

Co-authored-by: Ray Epps <[email protected]>

docs/string/trim.mdx

@@ -6,12 +6,18 @@ group: String
 
 ## Basic usage
 
-Trims all prefix and suffix characters from the given string. Like the builtin trim function but accepts other characters you would like to trim.
+Trims all prefix and suffix characters from the given string. Like the builtin trim function but accepts alternate (other than space) characters you would like to trim.
 
 ```ts
 import { trim } from 'radash'
 
-trim('  hello ') // => 'hello'
-trim('__hello__', '_') // => 'hello'
-trim('/repos/:owner/:repo/', '/') // => 'repos/:owner/:repo'
+trim('  hello ') // => hello
+trim('__hello__', '_') // => hello
+trim('/repos/:owner/', '/') // => repos/:owner/
+```
+
+Trim also handles more than one character to trim.
+
+```ts
+trim('222__hello__111', '12_') // => hello
 ```

src/string.ts

@@ -120,12 +120,14 @@ export const template = (
 /**
  * Trims all prefix and suffix characters from the given
  * string. Like the builtin trim function but accepts
- * other characters you would like to trim.
+ * other characters you would like to trim and trims
+ * multiple characters.
  *
  * ```typescript
  * trim('  hello ') // => 'hello'
  * trim('__hello__', '_') // => 'hello'
  * trim('/repos/:owner/:repo/', '/') // => 'repos/:owner/:repo'
+ * trim('222222__hello__1111111', '12_') // => 'hello'
  * ```
  */
 export const trim = (

src/tests/string.test.ts

@@ -177,6 +177,7 @@ describe('string module', () => {
       assert.equal(_.trim(undefined), '')
     })
     test('returns input string correctly trimmed', () => {
+      assert.equal(_.trim('\n\n\t\nhello\n\t  \n', '\n\t '), 'hello')
       assert.equal(_.trim('hello', 'x'), 'hello')
       assert.equal(_.trim(' hello  '), 'hello')
       assert.equal(_.trim(' __hello__  ', '_'), ' __hello__  ')