mongoskin - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

lib/mongoskin/index.js

@@ -90,8 +90,12 @@ /*!
 /**
- * constructor SkinDb from serverURLs
+ * constructor SkinDb from serverURL[s]
  *
- * RepliSet: mongoskin.db(serverURLs, options)
+ * ReplicaSet: mongoskin.db(serverURLs, dbOptions, replicasetOptions)
  *
  * ```js
- * mongoskin.db(['192.168.0.1:27017/', '192.168.0.2/?auto_reconnect', '192.168.0.3'], { database: 'mydb' })
+ * mongoskin.db([
+ *   '192.168.0.1:27017/',
+ *   '192.168.0.2/?auto_reconnect',
+ *   '192.168.0.3'
+ * ], {database: 'mydb'}, {connectArbiter: false, socketOptions: {timeout: 2000}});
  * ```
@@ -102,18 +106,21 @@ *
  * ```js
- * mongoskin.db('192.168.0.1:27017/mydb')
+ * mongoskin.db('192.168.0.1:27017/mydb');
+ * // or
+ * mongoskin.db('192.168.0.1:27017', {database: 'mydb'});
+ * // set the connection timeout to `2000ms`
+ * mongoskin.db('192.168.0.1:27017', {database: 'mydb', socketOptions: {timeout: 2000}});
  * ```
  * 
- * or
- *
- * ```js
- * mongoskin.db('192.168.0.1:27017', { database: 'mydb' })
- * ```
- * 
- * @param {String} serverUrl
- * @param {Object} [options]
+ * @param {String|Array} serverUrl or server urls.
+ * @param {Object} [dbOptions]
+ *  - {Object} socketOptions: @see http://mongodb.github.com/node-mongodb-native/markdown-docs/database.html#socket-options
+ *  - the other, @see http://mongodb.github.com/node-mongodb-native/markdown-docs/database.html#db-options
+ * @param {Object} [replicasetOptions], options for replicaset.
+ *   The detail of this options, please
+ *   @see https://github.com/mongodb/node-mongodb-native/blob/master/lib/mongodb/connection/repl_set.js#L27.
  * @return {SkinDb}
  * @api public
  */
-exports.db = function (serverUrl, options) {
-  options = options || {};
+exports.db = function (serverUrl, dbOptions, replicasetOptions) {
+  dbOptions = dbOptions || {};
 
@@ -123,6 +130,6 @@ var server, database, config;
   if (Array.isArray(serverUrl)) {
-    if (!options.database) {
-      throw new Error('Please provide a database in options to connect.');
+    if (!dbOptions.database) {
+      throw new Error('Please provide a database in `dbOptions` to connect.');
     }
-    database = options.database;
+    database = dbOptions.database;
 
@@ -138,15 +145,19 @@ var len = serverUrl.length;
     }
-    server = new ReplSetServers(servers);
+    server = new ReplSetServers(servers, replicasetOptions);
   } else {
     config = parseUrl(serverUrl);
-    database = options.database || config.database;
+    database = dbOptions.database || config.database;
     if (!database) {
       throw new Error('Please provide a database to connect to.');
     }
-    
+    var socketOptions = dbOptions.socketOptions;
+    if (socketOptions) {
+      delete dbOptions.socketOptions;
+      config.options.socketOptions = socketOptions;
+    }
     server = new Server(config.host, config.port, config.options);
 
-    if (options.username === undefined) {
-      options.username = config.username;
-      options.password = config.password;
+    if (dbOptions.username === undefined) {
+      dbOptions.username = config.username;
+      dbOptions.password = config.password;
     }
@@ -156,3 +167,3 @@ }
   var skinServer = new SkinServer(server);
-  return skinServer.db(database, options);
+  return skinServer.db(database, dbOptions);
 };
@@ -159,0 +170,0 @@

lib/mongoskin/server.js

@@ -46,4 +46,2 @@ /*!
     var password = options.password;
-    delete options.username;
-    delete options.password;
     if (!options.native_parser) {
@@ -50,0 +48,0 @@ options.native_parser = !! mongodb.BSONNative;

package.json

 {
   "name": "mongoskin",
   "description": "The future layer above node-mongodb-native",
-  "version": "0.4.0",
-  "author": "Gui Lin<[e-mail]>",
+  "version": "0.4.1",
+  "author": "Gui Lin <[e-mail]>",
+  "homepage": "https://github.com/kissjs/node-mongoskin",
   "repository": {
@@ -10,5 +11,10 @@ "type": "git",
   },
-  "main": "index",
+  "bugs": {
+    "url": "https://github.com/kissjs/node-mongoskin/issues"
+  },
+  "main": "./index.js",
   "keywords": [
-    "mongodb", "database", "nosql"
+    "mongodb",
+    "database",
+    "nosql"
   ],
@@ -19,3 +25,3 @@ "engines": {
   "dependencies": {
-    "mongodb": ">= 0.9.8 < 1.1.0"
+    "mongodb": "< 1.2.0"
   },
@@ -26,5 +32,10 @@ "devDependencies": {
   },
+  "scripts": {
+    "test": "make test-version"
+  },
   "directories": {
-    "lib": "lib/mongoskin"
-  }
+    "example": "./examples",
+    "lib": "./lib/mongoskin"
+  },
+  "license": "MIT"
 }

Readme.md

@@ -15,5 +15,6 @@ # mongoskin
 
-* >= 0.9.8
+* <del>>= 0.9.8 < 1.0.0</del>: mongodb have bug, it will throw a `TypeError: object is not a function` 
+  when connection open error.
 * 1.0.x
-* (bug)1.1.x
+* 1.1.x
 
@@ -20,0 +21,0 @@ ```bash

New alerts

Non-existent author

Supply chain risk

The package was published by an npm account that no longer exists.

Found 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Number of low maintenance alerts

1

-50%

Number of low quality alerts

1

-50%

Number of lines in readme file

695

0.14%

Worsened metrics

Total package byte prevSize

61813

-39.22%

Number of package files

31

-24.39%

Lines of code

1385

-36.7%

Number of high supply chain risk alerts

1

Infinity%

Dependency changes

• + Added

  bson@0.1.5
  (transitive)

• + Added

  mongodb@1.1.11
  (transitive)

• - Removed

  bson@0.0.6
  (transitive)

• - Removed

  mongodb@1.0.2
  (transitive)

• Updated

  mongodb@< 1.2.0