feat: add url/withoutTrailingSlash

Author: baxyz

benchmarks/url/withoutTrailingSlash.bench.ts

@@ -0,0 +1,16 @@
+import { withoutTrailingSlash } from 'radashi'
+
+describe('withoutTrailingSlash', () => {
+  bench('with no input', () => {
+    withoutTrailingSlash(undefined)
+  })
+  bench('with empty string', () => {
+    withoutTrailingSlash('')
+  })
+  bench('with trailing slash', () => {
+    withoutTrailingSlash('some/path/')
+  })
+  bench('without trailing slash', () => {
+    withoutTrailingSlash('some/path')
+  })
+})

docs/url/withoutTrailingSlash.mdx

@@ -0,0 +1,22 @@
+---
+title: withoutTrailingSlash
+description: Removes the trailing slash
+---
+
+### Usage
+
+Removes the trailing slash `/` from the given URL if it is present.
+
+This function is useful for ensuring that URLs are properly formatted
+without a trailing slash, which is often required in web development for
+consistency and to avoid issues with relative paths.
+
+```ts
+import { withoutTrailingSlash } from 'radashi'
+
+withoutTrailingSlash('') // => ''
+withoutTrailingSlash('no/slash/') // => 'no/slash'
+withoutTrailingSlash('already/has/slash') // => 'already/has/slash'
+withoutTrailingSlash(undefined) // => undefined
+withoutTrailingSlash(null) // => null
+```

src/mod.ts

@@ -144,6 +144,7 @@ export * from './typed/isWeakSet.ts'
 
 export * from './url/withLeadingSlash.ts'
 export * from './url/withoutLeadingSlash.ts'
+export * from './url/withoutTrailingSlash.ts'
 export * from './url/withTrailingSlash.ts'
 
 export * from './types.ts'

src/url/withoutTrailingSlash.ts

@@ -0,0 +1,102 @@
+/**
+ * Removes the trailing slash `/` from the given URL if it is present.
+ *
+ * This function is useful for ensuring that URLs are properly formatted
+ * without a trailing slash, which is often required in web development for
+ * consistency and to avoid issues with relative paths.
+ *
+ * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`.
+ * @returns The URL string without a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`.
+ *
+ * @see https://radashi.js.org/reference/url/withoutTrailingSlash
+ *
+ * @example
+ * ```ts
+ * withoutTrailingSlash('') // => ''
+ * withoutTrailingSlash('/') // => ''
+ * withoutTrailingSlash('no/slash/') // => 'no/slash'
+ * withoutTrailingSlash('already/has/slash') // => 'already/has/slash'
+ * withoutTrailingSlash(undefined) // => undefined
+ * withoutTrailingSlash(null) // => null
+ * ```
+ */
+export function withoutTrailingSlash(url: string): string
+
+/**
+ * Removes the trailing slash `/` from the given URL if it is present.
+ *
+ * This function is useful for ensuring that URLs are properly formatted
+ * without a trailing slash, which is often required in web development for
+ * consistency and to avoid issues with relative paths.
+ *
+ * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`.
+ * @returns The URL string without a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`.
+ *
+ * @see https://radashi.js.org/reference/url/withoutTrailingSlash
+ *
+ * @example
+ * ```ts
+ * withoutTrailingSlash('') // => ''
+ * withoutTrailingSlash('/') // => ''
+ * withoutTrailingSlash('no/slash/') // => 'no/slash'
+ * withoutTrailingSlash('already/has/slash') // => 'already/has/slash'
+ * withoutTrailingSlash(undefined) // => undefined
+ * withoutTrailingSlash(null) // => null
+ * ```
+ */
+export function withoutTrailingSlash(url: undefined): undefined
+
+/**
+ * Removes the trailing slash `/` from the given URL if it is present.
+ *
+ * This function is useful for ensuring that URLs are properly formatted
+ * without a trailing slash, which is often required in web development for
+ * consistency and to avoid issues with relative paths.
+ *
+ * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`.
+ * @returns The URL string without a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`.
+ *
+ * @see https://radashi.js.org/reference/url/withoutTrailingSlash
+ *
+ * @example
+ * ```ts
+ * withoutTrailingSlash('') // => ''
+ * withoutTrailingSlash('/') // => ''
+ * withoutTrailingSlash('no/slash/') // => 'no/slash'
+ * withoutTrailingSlash('already/has/slash') // => 'already/has/slash'
+ * withoutTrailingSlash(undefined) // => undefined
+ * withoutTrailingSlash(null) // => null
+ * ```
+ */
+export function withoutTrailingSlash(url: null): null
+
+/**
+ * Removes the trailing slash `/` from the given URL if it is present.
+ *
+ * This function is useful for ensuring that URLs are properly formatted
+ * without a trailing slash, which is often required in web development for
+ * consistency and to avoid issues with relative paths.
+ *
+ * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`.
+ * @returns The URL string without a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`.
+ *
+ * @see https://radashi.js.org/reference/url/withoutTrailingSlash
+ *
+ * @example
+ * ```ts
+ * withoutTrailingSlash('') // => ''
+ * withoutTrailingSlash('/') // => ''
+ * withoutTrailingSlash('no/slash/') // => 'no/slash'
+ * withoutTrailingSlash('already/has/slash') // => 'already/has/slash'
+ * withoutTrailingSlash(undefined) // => undefined
+ * withoutTrailingSlash(null) // => null
+ * ```
+ */
+export function withoutTrailingSlash(
+  url: string | undefined | null,
+): string | undefined | null {
+  if (url === undefined || url === null) {
+    return url
+  }
+  return url[url.length - 1] === '/' ? url.slice(0, -1) : url
+}

tests/url/withoutTrailingSlash.test.ts

@@ -0,0 +1,27 @@
+import { withoutTrailingSlash } from 'radashi'
+
+describe('withoutTrailingSlash', () => {
+  test('should return undefined if input is undefined', () => {
+    expect(withoutTrailingSlash(undefined)).toBe(undefined)
+  })
+  test('should return null if input is null', () => {
+    expect(withoutTrailingSlash(null)).toBe(null)
+  })
+  test('should remove trailing slash if present', () => {
+    expect(withoutTrailingSlash('foo/')).toBe('foo')
+  })
+  test('should do nothing if input is an empty string', () => {
+    expect(withoutTrailingSlash('')).toBe('')
+  })
+  test('should do nothing if input does not have a trailing slash', () => {
+    expect(withoutTrailingSlash('text-without-slash')).toBe(
+      'text-without-slash',
+    )
+  })
+  test('should remove last slash if input is a string of slashes', () => {
+    expect(withoutTrailingSlash('/////////')).toBe('////////')
+  })
+  test('should return an empty string if input is a single slash', () => {
+    expect(withoutTrailingSlash('/')).toBe('')
+  })
+})