diff --git a/README.md b/README.md index 9da254c..f327537 100755 --- a/README.md +++ b/README.md @@ -53,6 +53,11 @@ You can use NeDB as an in-memory only datastore or as a persistent datastore. On * `afterSerialization` (optional): hook you can use to transform data after it was serialized and before it is written to disk. Can be used for example to encrypt data before writing database to disk. This function takes a string as parameter (one line of an NeDB data file) and outputs the transformed string, **which must absolutely not contain a `\n` character** (or data will be lost). * `beforeDeserialization` (optional): inverse of `afterSerialization`. Make sure to include both and not just one or you risk data loss. For the same reason, make sure both functions are inverses of one another. Some failsafe mechanisms are in place to prevent data loss if you misuse the serialization hooks: NeDB checks that never one is declared without the other, and checks that they are reverse of one another by testing on random strings of various lengths. In addition, if too much data is detected as corrupt, NeDB will refuse to start as it could mean you're not using the deserialization hook corresponding to the serialization hook used before (see below). * `corruptAlertThreshold` (optional): between 0 and 1, defaults to 10%. NeDB will refuse to start if more than this percentage of the datafile is corrupt. 0 means you don't tolerate any corruption, 1 means you don't care. +* `compareStrings` (optional): function compareStrings(a, b) compares + strings a and b and return -1, 0 or 1. If specified, it overrides +default string comparison which is not well adapted to non-US characters +in particular accented letters. Native `localCompare` will most of the +time be the right choice * `nodeWebkitAppName` (optional, **DEPRECATED**): if you are using NeDB from whithin a Node Webkit app, specify its name (the same one you use in the `package.json`) in this field and the `filename` will be relative to the directory Node Webkit uses to store the rest of the application's data (local storage etc.). It works on Linux, OS X and Windows. Now that you can use `require('nw.gui').App.dataPath` in Node Webkit to get the path to the data directory for your application, you should not use this option anymore and it will be removed. If you use a persistent datastore without the `autoload` option, you need to call `loadDatabase` manually. diff --git a/package.json b/package.json index ee73d05..c1fe89c 100755 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nedb", - "version": "1.6.0", + "version": "1.6.1", "author": { "name": "Louis Chatriot", "email": "louis.chatriot@gmail.com"