nedb - npm Package Compare versions

Comparing version 1.5.0 to 1.5.1

lib/cursor.js

@@ -80,3 +80,3 @@ /**
   keys.forEach(function (k) {
-    if (action !== undefined && self._projection[k] !== action) { throw "Can't both keep and omit fields except for _id"; }
+    if (action !== undefined && self._projection[k] !== action) { throw new Error("Can't both keep and omit fields except for _id"); }
     action = self._projection[k];
@@ -83,0 +83,0 @@ });

lib/model.js

@@ -32,7 +32,7 @@ /**
   if (k[0] === '$' && !(k === '$$date' && typeof v === 'number') && !(k === '$$deleted' && v === true) && !(k === '$$indexCreated') && !(k === '$$indexRemoved')) {
-    throw 'Field names cannot begin with the $ character';
+    throw new Error('Field names cannot begin with the $ character');
   }
 
   if (k.indexOf('.') !== -1) {
-    throw 'Field names cannot contain a .';
+    throw new Error('Field names cannot contain a .');
   }
@@ -270,7 +270,7 @@ }
 
-  if (!util.isArray(obj[field])) { throw "Can't $push an element on non-array values"; }
+  if (!util.isArray(obj[field])) { throw new Error("Can't $push an element on non-array values"); }
 
   if (value !== null && typeof value === 'object' && value.$each) {
-    if (Object.keys(value).length > 1) { throw "Can't use another field in conjunction with $each"; }
-    if (!util.isArray(value.$each)) { throw "$each requires an array value"; }
+    if (Object.keys(value).length > 1) { throw new Error("Can't use another field in conjunction with $each"); }
+    if (!util.isArray(value.$each)) { throw new Error("$each requires an array value"); }
 
@@ -297,7 +297,7 @@ value.$each.forEach(function (v) {
 
-  if (!util.isArray(obj[field])) { throw "Can't $addToSet an element on non-array values"; }
+  if (!util.isArray(obj[field])) { throw new Error("Can't $addToSet an element on non-array values"); }
 
   if (value !== null && typeof value === 'object' && value.$each) {
-    if (Object.keys(value).length > 1) { throw "Can't use another field in conjunction with $each"; }
-    if (!util.isArray(value.$each)) { throw "$each requires an array value"; }
+    if (Object.keys(value).length > 1) { throw new Error("Can't use another field in conjunction with $each"); }
+    if (!util.isArray(value.$each)) { throw new Error("$each requires an array value"); }
 
@@ -320,4 +320,4 @@ value.$each.forEach(function (v) {
 lastStepModifierFunctions.$pop = function (obj, field, value) {
-  if (!util.isArray(obj[field])) { throw "Can't $pop an element from non-array values"; }
-  if (typeof value !== 'number') { throw value + " isn't an integer, can't use it with $pop"; }
+  if (!util.isArray(obj[field])) { throw new Error("Can't $pop an element from non-array values"); }
+  if (typeof value !== 'number') { throw new Error(value + " isn't an integer, can't use it with $pop"); }
   if (value === 0) { return; }
@@ -339,3 +339,3 @@
 
-  if (!util.isArray(obj[field])) { throw "Can't $pull an element from non-array values"; }
+  if (!util.isArray(obj[field])) { throw new Error("Can't $pull an element from non-array values"); }
 
@@ -355,3 +355,3 @@ arr = obj[field];
 lastStepModifierFunctions.$inc = function (obj, field, value) {
-  if (typeof value !== 'number') { throw value + " must be a number"; }
+  if (typeof value !== 'number') { throw new Error(value + " must be a number"); }
 
@@ -362,3 +362,3 @@ if (typeof obj[field] !== 'number') {
     } else {
-      throw "Don't use the $inc modifier on non-number fields";
+      throw new Error("Don't use the $inc modifier on non-number fields");
     }
@@ -400,6 +400,6 @@ } else {
 
-  if (keys.indexOf('_id') !== -1 && updateQuery._id !== obj._id) { throw "You cannot change a document's _id"; }
+  if (keys.indexOf('_id') !== -1 && updateQuery._id !== obj._id) { throw new Error("You cannot change a document's _id"); }
 
   if (dollarFirstChars.length !== 0 && dollarFirstChars.length !== firstChars.length) {
-    throw "You cannot mix modifiers and normal fields";
+    throw new Error("You cannot mix modifiers and normal fields");
   }
@@ -418,3 +418,3 @@
 
-      if (!modifierFunctions[m]) { throw "Unknown modifier " + m; }
+      if (!modifierFunctions[m]) { throw new Error("Unknown modifier " + m); }
 
@@ -424,3 +424,3 @@ // Can't rely on Object.keys throwing on non objects since ES6{
       if (typeof updateQuery[m] !== 'object') {
-        throw "Modifier " + m + "'s argument must be an object";
+        throw new Error("Modifier " + m + "'s argument must be an object");
       }
@@ -438,3 +438,3 @@
 
-  if (obj._id !== newDoc._id) { throw "You can't change a document's _id"; }
+  if (obj._id !== newDoc._id) { throw new Error("You can't change a document's _id"); }
   return newDoc;
@@ -564,3 +564,3 @@ };
 
-  if (!util.isArray(b)) { throw "$in operator called with a non-array"; }
+  if (!util.isArray(b)) { throw new Error("$in operator called with a non-array"); }
 
@@ -575,3 +575,3 @@ for (i = 0; i < b.length; i += 1) {
 comparisonFunctions.$nin = function (a, b) {
-  if (!util.isArray(b)) { throw "$nin operator called with a non-array"; }
+  if (!util.isArray(b)) { throw new Error("$nin operator called with a non-array"); }
 
@@ -582,3 +582,3 @@ return !comparisonFunctions.$in(a, b);
 comparisonFunctions.$regex = function (a, b) {
-  if (!util.isRegExp(b)) { throw "$regex operator called with non regular expression"; }
+  if (!util.isRegExp(b)) { throw new Error("$regex operator called with non regular expression"); }
 
@@ -609,3 +609,3 @@ if (typeof a !== 'string') {
     if (!util.isArray(obj)) { return false; }
-    if (value % 1 !== 0) { throw "$size operator called without an integer"; }
+    if (value % 1 !== 0) { throw new Error("$size operator called without an integer"); }
 
@@ -625,3 +625,3 @@ return (obj.length == value);
 
-  if (!util.isArray(query)) { throw "$or operator used without an array"; }
+  if (!util.isArray(query)) { throw new Error("$or operator used without an array"); }
 
@@ -644,3 +644,3 @@ for (i = 0; i < query.length; i += 1) {
 
-  if (!util.isArray(query)) { throw "$and operator used without an array"; }
+  if (!util.isArray(query)) { throw new Error("$and operator used without an array"); }
 
@@ -673,6 +673,6 @@ for (i = 0; i < query.length; i += 1) {
 
-  if (!_.isFunction(fn)) { throw "$where operator used without a function"; }
+  if (!_.isFunction(fn)) { throw new Error("$where operator used without a function"); }
 
   result = fn.call(obj);
-  if (!_.isBoolean(result)) { throw "$where function must return boolean"; }
+  if (!_.isBoolean(result)) { throw new Error("$where function must return boolean"); }
 
@@ -705,3 +705,3 @@ return result;
     if (queryKey[0] === '$') {
-      if (!logicalOperators[queryKey]) { throw "Unknown logical operator " + queryKey; }
+      if (!logicalOperators[queryKey]) { throw new Error("Unknown logical operator " + queryKey); }
       if (!logicalOperators[queryKey](obj, queryValue)) { return false; }
@@ -750,3 +750,3 @@ } else {
     if (dollarFirstChars.length !== 0 && dollarFirstChars.length !== firstChars.length) {
-      throw "You cannot mix operators and normal fields";
+      throw new Error("You cannot mix operators and normal fields");
     }
@@ -757,3 +757,3 @@
       for (i = 0; i < keys.length; i += 1) {
-        if (!comparisonFunctions[keys[i]]) { throw "Unknown comparison function " + keys[i]; }
+        if (!comparisonFunctions[keys[i]]) { throw new Error("Unknown comparison function " + keys[i]); }
 
@@ -760,0 +760,0 @@ if (!comparisonFunctions[keys[i]](objValue, queryValue[keys[i]])) { return false; }

lib/persistence.js

@@ -32,3 +32,3 @@ /**
   if (!this.inMemoryOnly && this.filename && this.filename.charAt(this.filename.length - 1) === '~') {
-    throw "The datafile name can't end with a ~, which is reserved for crash safe backup files";
+    throw new Error("The datafile name can't end with a ~, which is reserved for crash safe backup files");
   }
@@ -38,6 +38,6 @@
   if (options.afterSerialization && !options.beforeDeserialization) {
-    throw "Serialization hook defined but deserialization hook undefined, cautiously refusing to start NeDB to prevent dataloss";
+    throw new Error("Serialization hook defined but deserialization hook undefined, cautiously refusing to start NeDB to prevent dataloss");
   }
   if (!options.afterSerialization && options.beforeDeserialization) {
-    throw "Serialization hook undefined but deserialization hook defined, cautiously refusing to start NeDB to prevent dataloss";
+    throw new Error("Serialization hook undefined but deserialization hook defined, cautiously refusing to start NeDB to prevent dataloss");
   }
@@ -50,3 +50,3 @@ this.afterSerialization = options.afterSerialization || function (s) { return s; };
       if (this.beforeDeserialization(this.afterSerialization(randomString)) !== randomString) {
-        throw "beforeDeserialization is not the reverse of afterSerialization, cautiously refusing to start NeDB to prevent dataloss";
+        throw new Error("beforeDeserialization is not the reverse of afterSerialization, cautiously refusing to start NeDB to prevent dataloss");
       }
@@ -95,3 +95,3 @@ }
       home = process.env.LOCALAPPDATA || process.env.APPDATA;
-      if (!home) { throw "Couldn't find the base application data folder"; }
+      if (!home) { throw new Error("Couldn't find the base application data folder"); }
       home = path.join(home, appName);
@@ -101,3 +101,3 @@ break;
       home = process.env.HOME;
-      if (!home) { throw "Couldn't find the base application data directory"; }
+      if (!home) { throw new Error("Couldn't find the base application data directory"); }
       home = path.join(home, 'Library', 'Application Support', appName);
@@ -107,7 +107,7 @@ break;
       home = process.env.HOME;
-      if (!home) { throw "Couldn't find the base application data directory"; }
+      if (!home) { throw new Error("Couldn't find the base application data directory"); }
       home = path.join(home, '.config', appName);
       break;
     default:
-      throw "Can't use the Node Webkit relative path for platform " + process.platform;
+      throw new Error("Can't use the Node Webkit relative path for platform " + process.platform);
       break;
@@ -244,3 +244,3 @@ }
   if (data.length > 0 && corruptItems / data.length > this.corruptAlertThreshold) {
-    throw "More than " + Math.floor(100 * this.corruptAlertThreshold) + "% of the data file is corrupt, the wrong beforeDeserialization hook may be used. Cautiously refusing to start NeDB to prevent dataloss"
+    throw new Error("More than " + Math.floor(100 * this.corruptAlertThreshold) + "% of the data file is corrupt, the wrong beforeDeserialization hook may be used. Cautiously refusing to start NeDB to prevent dataloss");
   }
@@ -247,0 +247,0 @@

package.json

 {
   "name": "nedb",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "author": {
@@ -24,3 +24,3 @@ "name": "Louis Chatriot",
     "async": "0.2.10",
-    "binary-search-tree": "0.2.4",
+    "binary-search-tree": "0.2.5",
     "localforage": "^1.3.0",
@@ -27,0 +27,0 @@ "mkdirp": "~0.5.1",

README.md

 <img src="http://i.imgur.com/9O1xHFb.png" style="width: 25%; height: 25%; float: left;">
 
-## The Javascript Database
+## The JavaScript Database
 
-**Embedded persistent or in memory database for Node.js, nw.js, Electron and browsers, 100% Javascript, no binary dependency**. API is a subset of MongoDB's and it's <a href="#speed">plenty fast</a>.
+**Embedded persistent or in memory database for Node.js, nw.js, Electron and browsers, 100% JavaScript, no binary dependency**. API is a subset of MongoDB's and it's <a href="#speed">plenty fast</a>.
 
@@ -19,10 +19,11 @@ **IMPORTANT NOTE**: Please don't submit issues for questions regarding your code. Only actual bugs or feature requests will be answered, all others will be closed without comment. Also, please follow the <a href="#bug-reporting-guidelines">bug reporting guidelines</a> and check the <a href="https://github.com/louischatriot/nedb/wiki/Change-log" target="_blank">change log</a> before submitting an already fixed bug :)
 Module name on npm and bower is `nedb`.
-```javascript
-npm install nedb --save   // Put latest version in your package.json
-npm test   // You'll need the dev dependencies to launch tests
-bower install nedb   // For the browser versions, which will be in browser-version/out
+
 ```
+npm install nedb --save    # Put latest version in your package.json
+npm test                   # You'll need the dev dependencies to launch tests
+bower install nedb         # For the browser versions, which will be in browser-version/out
+```
 
 ## API
-It's a subset of MongoDB's API (the most used operations).
+It is a subset of MongoDB's API (the most used operations).
 
@@ -48,14 +49,10 @@ * <a href="#creatingloading-a-database">Creating/loading a database</a>
 
-* `filename` (optional): path to the file where the data is persisted. If left blank, the datastore is automatically considered in-memory only. It cannot end with a `~` which is used in the temporary files NeDB uses to perform crash-safe writes
-* `inMemoryOnly` (optional, defaults to false): as the name implies.
-* `timestampData` (optional, defaults to false): timestamp the insertion and last update of all documents, with the fields `createdAt` and `updatedAt`. User-specified values override automatic generation, usually useful for testing.
-* `autoload` (optional, defaults to false): if used, the database will
-  automatically be loaded from the datafile upon creation (you don't
-need to call `loadDatabase`). Any command
-issued before load is finished is buffered and will be executed when
-load is done.
+* `filename` (optional): path to the file where the data is persisted. If left blank, the datastore is automatically considered in-memory only. It cannot end with a `~` which is used in the temporary files NeDB uses to perform crash-safe writes.
+* `inMemoryOnly` (optional, defaults to `false`): as the name implies.
+* `timestampData` (optional, defaults to `false`): timestamp the insertion and last update of all documents, with the fields `createdAt` and `updatedAt`. User-specified values override automatic generation, usually useful for testing.
+* `autoload` (optional, defaults to `false`): if used, the database will automatically be loaded from the datafile upon creation (you don't need to call `loadDatabase`). Any command issued before load is finished is buffered and will be executed when load is done.
 * `onload` (optional): if you use autoloading, this is the handler called after the `loadDatabase`. It takes one `error` argument. If you use autoloading without specifying this handler, and an error happens during load, an error will be thrown.
-* `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): reverse 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 
+* `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.
 * `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.
@@ -68,2 +65,4 @@
 
+Also, if `loadDatabase` fails, all commands registered to the executor afterwards will not be executed. They will be registered and executed, in sequence, only after a successful `loadDatabase`.
+
 ```javascript
@@ -108,3 +107,3 @@ // Type 1: In-memory only datastore (no need to load the database)
 ### Persistence
-Under the hood, NeDB's persistence uses an append-only format, meaning that all updates and deletes actually result in lines added at the end of the datafile, for performance reasons. The database is automatically compacted (i.e. put back in the one-line-per-document format) everytime your application restarts.
+Under the hood, NeDB's persistence uses an append-only format, meaning that all updates and deletes actually result in lines added at the end of the datafile, for performance reasons. The database is automatically compacted (i.e. put back in the one-line-per-document format) every time you load each database within your application.
 
@@ -117,2 +116,4 @@ You can manually call the compaction function with `yourDatabase.persistence.compactDatafile` which takes no argument. It queues a compaction of the datafile in the executor, to be executed sequentially after all pending operations.
 
+Compaction will also immediately remove any documents whose data line has become corrupted, assuming that the total percentage of all corrupted documents in that database still falls below the specified `corruptAlertThreshold` option's value.
+
 Durability works similarly to major databases: compaction forces the OS to physically flush data to disk, while appends to the data file do not (the OS is responsible for flushing the data). That guarantees that a server crash can never cause complete data loss, while preserving performance. The worst that can happen is a crash between two syncs, causing a loss of all data between the two syncs. Usually syncs are 30 seconds appart so that's at most 30 seconds of data. <a href="http://oldblog.antirez.com/post/redis-persistence-demystified.html" target="_blank">This post by Antirez on Redis persistence</a> explains this in more details, NeDB being very close to Redis AOF persistence with `appendfsync` option set to `no`.
@@ -148,2 +149,3 @@
 You can also bulk-insert an array of documents. This operation is atomic, meaning that if one insert fails due to a unique constraint being violated, all changes are rolled back.
+
 ```javascript
@@ -150,0 +152,0 @@ db.insert([{ a: 5 }, { a: 42 }], function (err, newDocs) {

test_lac/loadAndCrash.test.js

@@ -82,5 +82,5 @@ /**
   if (!options || typeof options === 'function') {
-    options = { encoding: 'utf8', mode: 0o666, flag: 'w' };
+    options = { encoding: 'utf8', mode: 438, flag: 'w' }; // Mode 438 == 0o666 (compatibility with older Node releases)
   } else if (typeof options === 'string') {
-    options = { encoding: options, mode: 0o666, flag: 'w' };
+    options = { encoding: options, mode: 438, flag: 'w' }; // Mode 438 == 0o666 (compatibility with older Node releases)
   } else if (typeof options !== 'object') {
@@ -87,0 +87,0 @@ throwOptionsError(options);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1260276

increased by0.08%

Number of lines in readme file

642

increased by0.31%

Dependency changes

• + Addedbinary-search-tree@0.2.5(transitive)

• - Removedbinary-search-tree@0.2.4(transitive)

• Updatedbinary-search-tree@0.2.5