README.md

stage-validator

Validates a MongoDB aggregation pipeline stage.

Usage

The main module exposes two functions: accepts(stageStr) and parse(stageStr).

accepts(stageStr)

The accepts(stageStr) function takes a pipeline stage string and returns true if the string is a valid MongoDB pipeline stage, false otherwise.

Example:

var accepts = require('compass-stage-validator').accepts;
var assert = require('assert');

assert.ok(accepts('{"$limit": 1}'));
assert.ok(accepts('{"match": {"x": 35}}'));

assert.equal(accepts('{"$invalid": "key"}'), false);

Related

• mongodb-query-parser Validate and parse MongoDB queries and projections
• mongodb-language-model Work with rich AST's of MongoDB queries
• @mongodb-js/compass-aggregations MongoDB Compass UI Plugin for building and debugging aggregation pipelines.

License

Apache 2.0