<commit_before>bind-crud
=========

CRUD for mono

####Example config:
```
listen: ["MIID1", "MIID2", ...]
```

####Example request data:
```
{
    t: 'templateType',
    q: {/*query object*/},
    d: {/*update document*/},
    o: {/*options*/},
    f: {/*fields*/}
}
```<commit_msg>Added documentation comments<commit_after>bind-crud
=========

CRUD for mono

####Example config:

```
listen: ["MIID1", "MIID2", ...]
```

This CRUD module will listen for `find`, `update`, `insert`, and `remove` events comming from these modules
and forward their requests to the server. All these events must have two parameters:

 * the CRUD object defined by the CRUD module. See example below.
 * the callback to be called with the results when the operation complete

####Example request data:
```js
{
    // the template this this CRUD object will be validated against
    t: 'templateType',
    // the query object in MongoDB format
    q: {/*query object*/},
    // the document object (updates) in MongoDB format
    d: {/*update document*/},
    // the CRUD operation options in node-monogdb-native (NodeJs MongoDb driver) format
    o: {/*options*/},
    // the CRUD operation projection in MongoDb format
    f: {/*fields*/}
}
```
{'fraction_non_alphanumeric': 0.16381418092909536, 'fraction_numerical': 0.0032599837000814994, 'mean_word_length': 3.4654545454545453, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1286739', 'n_tokens_mistral': 385, 'n_tokens_neox': 366, 'n_words': 144}