monk-middleware-debug

0.2.0 verified Sat Apr 25 auth: no javascript deprecated

A debug middleware for monk versions >=5.0.0. It logs MongoDB operations to the console using the debug module. Current stable version is 0.2.0, but note that it is part of the monk ecosystem and has been superseded by monk's built-in debugging capabilities. It requires monk >=5.0.0 and mongodb driver. Release cadence is low; no active development. Key differentiator: lightweight, specifically for monk.

Common errors

error TypeError: debugMiddleware is not a function ↓

cause Importing named export instead of default export.

fix

Use default import: import debugMiddleware from 'monk-middleware-debug'

error Error: Middleware must be a function ↓

cause Calling debugMiddleware without parentheses, passing the function reference instead of its return value.

fix

Add parentheses: db.addMiddleware(debugMiddleware())

error Cannot find module 'monk-middleware-debug' ↓

cause Package not installed or missing from dependencies.

fix

Run npm install monk-middleware-debug

Warnings

deprecated This package is no longer actively maintained; monk has built-in debugging via 'debug' module. Use monk's native debug instead. ↓

fix Remove middleware and set environment variable DEBUG=monk:* to see debug logs.

breaking Requires monk >=5.0.0; incompatible with older monk versions. ↓

fix Update monk to version >=5.0.0.

gotcha The middleware must be added before any queries are made; otherwise debug logs won't show. ↓

fix Call db.addMiddleware(debugMiddleware()) immediately after creating the monk instance.

Install

npm install monk-middleware-debug

yarn add monk-middleware-debug

pnpm add monk-middleware-debug

Imports

default

wrong

const debugMiddleware = require('monk-middleware-debug')

correct

import debugMiddleware from 'monk-middleware-debug'

ESM default import is correct; CommonJS require works but may not be type-safe.

default

wrong

const { debugMiddleware } = require('monk-middleware-debug')

correct

const debugMiddleware = require('monk-middleware-debug')

This package exports a single function as default; named destructure does not work.

debugMiddleware

wrong

import { debugMiddleware } from 'monk-middleware-debug'

correct

import debugMiddleware from 'monk-middleware-debug'

The default export is unnamed; use any name you like.

Quickstart

Shows how to add debug middleware to a monk instance and execute a query.

import monk from 'monk';
import debugMiddleware from 'monk-middleware-debug';

const db = monk('localhost/mydb');
db.addMiddleware(debugMiddleware());

const collection = db.get('users');
collection.find({}).then(console.log);