Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
mongodb-connection-string-url
Advanced tools
Package description
The mongodb-connection-string-url npm package is designed to parse and manipulate MongoDB connection strings according to the MongoDB connection string specification. It provides a convenient way to work with MongoDB connection strings, allowing users to easily read, modify, and construct connection strings in a programmatic way.
Parsing a MongoDB connection string
This feature allows you to parse a MongoDB connection string and access its components, such as hosts, database name, and options.
"const { ConnectionString } = require('mongodb-connection-string-url');\nconst connectionString = new ConnectionString('mongodb://localhost:27017');\nconsole.log(connectionString.hosts); // Outputs: ['localhost:27017']"
Modifying the database name
This feature demonstrates how to modify the database name in a MongoDB connection string using the package.
"const { ConnectionString } = require('mongodb-connection-string-url');\nconst connectionString = new ConnectionString('mongodb://localhost:27017/mydatabase');\nconnectionString.pathname = '/anotherdatabase';\nconsole.log(connectionString.toString()); // Outputs: 'mongodb://localhost:27017/anotherdatabase'"
Adding query parameters
This feature shows how to add query parameters to a MongoDB connection string, which can be used to specify options such as retryWrites.
"const { ConnectionString } = require('mongodb-connection-string-url');\nconst connectionString = new ConnectionString('mongodb://localhost:27017');\nconnectionString.searchParams.set('retryWrites', 'true');\nconsole.log(connectionString.toString()); // Outputs: 'mongodb://localhost:27017/?retryWrites=true'"
The mongodb-uri package is similar in that it also provides functionality for parsing and formatting MongoDB URIs. However, mongodb-connection-string-url offers a more modern API and additional capabilities for manipulating the connection string components directly.
While connection-string is a more general-purpose package for parsing and building connection strings, not limited to MongoDB, mongodb-connection-string-url is specifically tailored for MongoDB connection strings, providing more specialized functionality in that context.
Readme
MongoDB connection strings, based on the WhatWG URL API
import ConnectionString from 'mongodb-connection-string-url';
const cs = new ConnectionString('mongodb://localhost');
cs.searchParams.set('readPreference', 'secondary');
console.log(cs.href); // 'mongodb://localhost/?readPreference=secondary'
.host
, .hostname
and .port
properties cannot be set, and reading
them does not return meaningful results (and are typed as never
in TypeScript).hosts
property contains a list of all hosts in the connection string.href
property cannot be set, only read.isSRV
property, set to true
for mongodb+srv://
.clone()
utility method on the prototypeApache-2.0
FAQs
MongoDB connection strings, based on the WhatWG URL API
The npm package mongodb-connection-string-url receives a total of 2,643,493 weekly downloads. As such, mongodb-connection-string-url popularity was classified as popular.
We found that mongodb-connection-string-url demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 32 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.