Registry / devops / qp-mongo-shell-server

qp-mongo-shell-server

library10.3.4jsnpmunverified

A gRPC server interface wrapping MongoDB Shell (mongosh) for programmatic access to MongoDB operations via Node.js REPL. Current stable version 10.3.4, part of the mongosh ecosystem from MongoDB/Chequer. Ships TypeScript types and supports Node >=18.3.0. Differentiates by exposing the full mongosh API over gRPC, enabling remote MongoDB shell execution and scripting.

devops

npm install qp-mongo-shell-server

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · QP-MONGO-SHELL-SER

qp-mongo-shell-server

devopsjavascriptv10.3.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

MongoShellServer

✓ import { MongoShellServer } from 'qp-mongo-shell-server'

✗ const MongoShellServer = require('qp-mongo-shell-server')

ESM-only; does not support CommonJS require()

startServer

✓ import { startServer } from 'qp-mongo-shell-server'

✗ import startServer from 'qp-mongo-shell-server'

Named export, not default export

MongoShellServerOptions

✓ import type { MongoShellServerOptions } from 'qp-mongo-shell-server'

✗ import { MongoShellServerOptions } from 'qp-mongo-shell-server'

TypeScript type; use import type to avoid runtime inclusion

Shows how to start a gRPC MongoDB shell server with custom port and MongoDB URI, handling errors.

import { startServer } from 'qp-mongo-shell-server'; const server = startServer({ port: 50051, mongodb: { uri: process.env.MONGO_URI ?? 'mongodb://localhost:27017' } }); server.on('error', (err) => { console.error('Server error:', err); }); console.log('gRPC server listening on port 50051');

Debug

Known issues

breakingNode.js version requirement increased to >=18.3.0

fix

Update Node.js to LTS version 18 or later

affects: >=10.0.0

deprecatedCommonJS require() no longer works; package is ESM-only

fix

Use import syntax or switch to dynamic import()

affects: >=10.0.0

gotchaThe default export changed from a class to a function in v10

fix

Use named import { MongoShellServer } instead of default import

affects: >=10.0.0

gotchagRPC port must be available; binding fails if port is already in use

fix

Ensure the port is free or implement retry logic

affects: *

Errors

Common errors & fixes

Error [ERR_MODULE_NOT_FOUND]: Cannot find module 'qp-mongo-shell-server'

Missing npm install or incorrect package name

fix

Run 'npm install qp-mongo-shell-server'

TypeError: MongoShellServer is not a constructor

Using default import instead of named import (ESM only)

fix

Use import { MongoShellServer } from 'qp-mongo-shell-server'

Error: listen EADDRINUSE :::50051

Port 50051 is already occupied by another process

fix

Kill the process using port 50051 or specify a different port

Upgrade

Version history

10.3.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubgit://github.com/chequer-io/mongosh ↗

packageqp-mongo-shell-server ↗

homepagehttps://github.com/chequer-io/mongosh#readme ↗