Registry / serialization / strip-url-auth

strip-url-auth

library2.0.0jsnpmunverified

strip-url-auth is a focused JavaScript utility that removes the username and password (authentication) portion from a given URL string. It is currently stable at version 2.0.0. Developed by Sindresorhus, it adheres to a philosophy of single-purpose, highly reliable modules. Key differentiators include its minimalistic API, robust parsing for common URL formats, and its strict adherence to modern JavaScript standards. Releases typically occur when necessary for compatibility with newer Node.js versions or to address specific edge cases, rather than on a fixed cadence. It provides a simple, direct solution for sanitizing URLs for display or storage where authentication credentials should not be exposed.

serialization auth-security

npm install strip-url-auth

github ↗package ↗

INSTALL

IMPORT

SIG · STRIP-URL-AUTH

strip-url-auth

serializationjavascriptv2.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

stripUrlAuth

✓ import stripUrlAuth from 'strip-url-auth';

✗ const stripUrlAuth = require('strip-url-auth');

Since v2.0.0, this package is pure ESM and must be imported using dynamic `import()` or static `import` statements in an ESM context. CommonJS `require()` is no longer supported and will throw an error.

This example demonstrates how to import and use `stripUrlAuth` to remove authentication credentials from various URL formats, including HTTPS and FTP, and shows its behavior with URLs that do not contain auth or have malformed auth segments.

import stripUrlAuth from 'strip-url-auth'; const urlWithAuth = 'https://admin:securepass@example.com/path?query=value#hash'; const urlWithoutAuth = stripUrlAuth(urlWithAuth); console.log(`Original URL: ${urlWithAuth}`); console.log(`URL without auth: ${urlWithoutAuth}`); // Example with no auth const simpleUrl = 'https://www.google.com'; const simpleUrlStripped = stripUrlAuth(simpleUrl); console.log(`\nOriginal simple URL: ${simpleUrl}`); console.log(`Stripped simple URL: ${simpleUrlStripped}`); // Demonstrating with a different protocol const ftpUrl = 'ftp://user:secret@ftp.example.org/files'; const ftpUrlStripped = stripUrlAuth(ftpUrl); console.log(`\nOriginal FTP URL: ${ftpUrl}`); console.log(`Stripped FTP URL: ${ftpUrlStripped}`); // Handles edge cases like empty auth or missing protocol gracefully const malformedAuthUrl = 'user:@host.com/path'; const malformedAuthUrlStripped = stripUrlAuth(malformedAuthUrl); console.log(`\nMalformed auth URL: ${malformedAuthUrl}`); console.log(`Stripped malformed auth URL: ${malformedAuthUrlStripped}`);

Debug

Known issues

breakingVersion 2.0.0 and newer are pure ESM (ECMAScript Modules). CommonJS `require()` is no longer supported. This affects how the package is imported and used in Node.js environments.

fix

Migrate your project to use ES Modules or use dynamic `import()` where necessary. Ensure your `package.json` has `"type": "module"` or use `.mjs` file extension for modules importing this package.

affects: >=2.0.0

breakingNode.js 12 or higher is now required for `strip-url-auth` v2.0.0 and subsequent versions. Older Node.js versions are not supported.

fix

Upgrade your Node.js runtime to version 12 or newer. If you cannot upgrade Node.js, you must remain on `strip-url-auth` v1.x.

affects: >=2.0.0

gotchaThis package only strips the user and password parts of the URL. It does not validate the URL's overall format or perform any other kind of comprehensive sanitization or encoding.

fix

For comprehensive URL validation or other manipulations (e.g., encoding components), combine this package with a dedicated URL parsing library like Node's built-in `URL` class or a third-party module like `url-parse`.

affects: all

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module .../node_modules/strip-url-auth/index.js from ... not supported.

Attempting to use `require()` to import `strip-url-auth` in a CommonJS module after upgrading to v2.0.0+.

fix

Change `const stripUrlAuth = require('strip-url-auth');` to `import stripUrlAuth from 'strip-url-auth';` and ensure your project is configured for ESM (e.g., `"type": "module"` in `package.json` or using `.mjs` file extensions).

SyntaxError: Cannot use import statement outside a module

Using `import stripUrlAuth from 'strip-url-auth';` in a CommonJS file (e.g., a `.js` file without `"type": "module"` in `package.json`) or an environment that doesn't support ESM.

fix

Ensure your project or file is treated as an ES Module by adding `"type": "module"` to your `package.json` or by changing the file extension to `.mjs`. Alternatively, if you must remain in CommonJS, consider dynamic import: `(async () => { const { default: stripUrlAuth } = await import('strip-url-auth'); /* use stripUrlAuth */ })();` or stick to v1.x of the package.

Upgrade

Version history

2.0.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

17 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/sindresorhus/strip-url-auth ↗

packagehttps://www.npmjs.com/package/strip-url-auth ↗