mongodb-connection-string-url

What is mongodb-connection-string-url?

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.

What are mongodb-connection-string-url's main functionalities?

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'"

Other packages similar to mongodb-connection-string-url

mongodb-uri

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.

connection-string

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-string-url

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'

Deviations from the WhatWG URL package

• URL parameters are case-insensitive
• The .host, .hostname and .port properties cannot be set, and reading them does not return meaningful results (and are typed as neverin TypeScript)
• The .hosts property contains a list of all hosts in the connection string
• The .href property cannot be set, only read
• There is an additional .isSRV property, set to true for mongodb+srv://
• There is an additional .clone() utility method on the prototype

LICENSE

Apache-2.0

Changelog

3.0.1 (2024-05-10)

• Nothing was changed in this release