Takes a deeply nested object and flattens it to a mongoDB compatible query object. For example:
const json = {
name: 'George Washington',
contact : {
phones: {
mobile: '1',
direct: '2'
}c
}
}
Would be transformed to:
{
name: 'George Washington',
'contact.phones.mobile': 1
'contact.phones.direct': 2
}
the deeply nested object that requires flattening
Deep inspects the input for any $where keys and deletes them. If the input is not an object, the original input will be returned.
Deep inspects the input for any keys that start with $ and deletes them. If the input is not an object, the original input will be returned.
Takes a json string, or an object, and sanitizes it with the provided filter function.
string or object to be sanitized. Note: if input is a string, and it cannot be parsed with JSON.parse a (SyntaxError)[https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError] will be thrown.
the function that filters what's permitted in the resulting object. Returns true if the key should be removed.
if the input was a valid JSON string, the result will be a sanitized JSON object
Excludes any properties that have $ fields that aren't in the white list
the user provided content that requires sanitization
the string array of $keys to allow
Generated using TypeDoc
SanitizeMongoDB is a set of utility functions to help sanitize user input to make it safe to pass to MongoDB. Remember, security is always the integrators' ultimate responsibility - SakuraApi is here to help you with security, not replace you.