feat: add url/withoutLeadingSlash

Author: baxyz

benchmarks/url/withoutLeadingSlash.bench.ts

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

docs/url/withoutLeadingSlash.mdx

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

src/mod.ts

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

src/url/withoutLeadingSlash.ts

@@ -0,0 +1,102 @@
+/**
+ * Removes the leading slash `/` from the given URL if it is present.
+ *
+ * This function is useful for ensuring that URLs are properly formatted
+ * without a leading 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 leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`.
+ *
+ * @see https://radashi.js.org/reference/url/withoutLeadingSlash
+ *
+ * @example
+ * ```ts
+ * withoutLeadingSlash('') // => ''
+ * withoutLeadingSlash('/') // => ''
+ * withoutLeadingSlash('/no/slash') // => 'no/slash'
+ * withoutLeadingSlash('already/has/slash') // => 'already/has/slash'
+ * withoutLeadingSlash(undefined) // => undefined
+ * withoutLeadingSlash(null) // => null
+ * ```
+ */
+export function withoutLeadingSlash(url: string): string
+
+/**
+ * Removes the leading slash `/` from the given URL if it is present.
+ *
+ * This function is useful for ensuring that URLs are properly formatted
+ * without a leading 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 leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`.
+ *
+ * @see https://radashi.js.org/reference/url/withoutLeadingSlash
+ *
+ * @example
+ * ```ts
+ * withoutLeadingSlash('') // => ''
+ * withoutLeadingSlash('/') // => ''
+ * withoutLeadingSlash('/no/slash') // => 'no/slash'
+ * withoutLeadingSlash('already/has/slash') // => 'already/has/slash'
+ * withoutLeadingSlash(undefined) // => undefined
+ * withoutLeadingSlash(null) // => null
+ * ```
+ */
+export function withoutLeadingSlash(url: undefined): undefined
+
+/**
+ * Removes the leading slash `/` from the given URL if it is present.
+ *
+ * This function is useful for ensuring that URLs are properly formatted
+ * without a leading 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 leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`.
+ *
+ * @see https://radashi.js.org/reference/url/withoutLeadingSlash
+ *
+ * @example
+ * ```ts
+ * withoutLeadingSlash('') // => ''
+ * withoutLeadingSlash('/') // => ''
+ * withoutLeadingSlash('/no/slash') // => 'no/slash'
+ * withoutLeadingSlash('already/has/slash') // => 'already/has/slash'
+ * withoutLeadingSlash(undefined) // => undefined
+ * withoutLeadingSlash(null) // => null
+ * ```
+ */
+export function withoutLeadingSlash(url: null): null
+
+/**
+ * Removes the leading slash `/` from the given URL if it is present.
+ *
+ * This function is useful for ensuring that URLs are properly formatted
+ * without a leading 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 leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`.
+ *
+ * @see https://radashi.js.org/reference/url/withoutLeadingSlash
+ *
+ * @example
+ * ```ts
+ * withoutLeadingSlash('') // => ''
+ * withoutLeadingSlash('/') // => ''
+ * withoutLeadingSlash('/no/slash') // => 'no/slash'
+ * withoutLeadingSlash('already/has/slash') // => 'already/has/slash'
+ * withoutLeadingSlash(undefined) // => undefined
+ * withoutLeadingSlash(null) // => null
+ * ```
+ */
+export function withoutLeadingSlash(
+  url: string | undefined | null,
+): string | undefined | null {
+  if (url === undefined || url === null) {
+    return url
+  }
+  return url[0] === '/' ? url.slice(1) : url
+}

tests/url/withoutLeadingSlash.test.ts

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