mongo-key-escape/Readme.md

Escape mongo keys for periods and dollar signs

# mongo-key-escape

  [Escape MongoDB keys](http://docs.mongodb.org/manual/faq/developers/#faq-dollar-sign-escaping) for characters `.` and `$`.

## Installation

    $ npm install mongo-key-escape

## Example

```js
var key = require('mongo-key-escape');

key.escape('event.thing');
// event\uFF0Ething
key.unescape('event\uFF0Ething');
// 'event.thing'

key.escape('event$thing');
// event\uFF04thing
key.unescape('event\uFF04thing');
// 'event$thing'
```

## License

MIT