Documentation: getPathWithoutLocale Functions in intlayer

    Description:

    Removes the locale segment from the given URL or pathname if present. It works with both absolute URLs and relative pathnames.

    Parameters:

    • inputUrl: string

      • Description: The complete URL string or pathname to process.
      • Type: string
    • locales: Locales[]

      • Description: Optional array of supported locales. Defaults to the configured locales in the project.
      • Type: Locales[]

    Returns:

    • Type: string
    • Description: The URL string or pathname without the locale segment.

    Example Usage:

    typescript
    import { getPathWithoutLocale } from "intlayer";
    
    console.log(getPathWithoutLocale("/dashboard")); // Output: "/dashboard"
    console.log(getPathWithoutLocale("/{{locale}}/dashboard")); // Output: "/dashboard"
    console.log(getPathWithoutLocale("/fr/dashboard")); // Output: "/dashboard"
    console.log(getPathWithoutLocale("https://example.com/{{locale}}/dashboard")); // Output: "https://example.com/dashboard"
    

    If you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.

    GitHub link to the documentation