Skip to main content

parseMongoDB

Converts a MongoDB query object or parseable string into a DefaultRuleGroupType or DefaultRuleGroupTypeIC.

Functions

FunctionDescription
isMongoDBExpressionOperandA MongoDB $expr comparison operand that is a candidate expression subtree: an aggregation-operator object (e.g. { $multiply: [...] }). Bare "$field" strings and literals are not expression operands. The expr-supplied getExpression handler decides whether it maps to a known function.
mongoDbFieldRefReads a MongoDB field-path operand ("$field"), returning the field name or null.
parseMongoDBConverts a MongoDB query object or parseable string into a query suitable for the index!QueryBuilder QueryBuilder component's query or defaultQuery props (DefaultRuleGroupType).

Interfaces

InterfaceDescription
ParseMongoDBExpressionContextContext passed to parseMongoDB!ParseMongoDbOptions.getExpression.
ParseMongoDbOptionsOptions object for parseMongoDB.

Type Aliases

Type AliasDescription
MongoDBExpressionOperandA MongoDB aggregation-expression operand that parseMongoDB!ParseMongoDbOptions.getExpression may receive — an aggregation-operator object ({ $add: [...] }, { $abs: x }, etc.), a "$field" path reference, or a literal.
MongoDbSupportedOperators-

caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.