Usage for SessionStore

arronzhang · Dec 16, 2011 · 5e2f0d3 · 5e2f0d3
1 parent 9b52bb4
commit 5e2f0d3
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/lib/session.js b/lib/session.js
@@ -1,5 +1,26 @@
 /**
  * connect session store
+ *
+ * Use in express or connect project
+ *
+ * Examples:
+ *
+ * 	Use in normal collection
+ *
+ * 		app.use(express.session({
+ * 		    store: new mongoq.SessionStore( mongoq("mongodb://localhost").collection("sessions") )
+ * 		}));
+ *
+ * 	Use in capped collection with max length 4096
+ *
+ * 		app.use(express.session({
+ * 		    store: new mongoq.SessionStore( mongoq("mongodb://localhost").collection("sessions", {
+ * 		    	capped: true,
+ * 		    	max: 4096, 
+ * 		    	size: 4096 * 8192 
+ * 		    }) )
+ * 		}));
+ *
  */
 
 /**