Skip to content
Browse files

Rebuild session docs

  • Loading branch information...
1 parent 94fbc5a commit 2347316cff462d8740fa0bf79d5597cf3cc2c184 @tj tj committed Jul 9, 2010
Showing with 9 additions and 7 deletions.
  1. +4 −3 docs/session.1
  2. +5 −4 docs/session.html
View
7 docs/session.1
@@ -42,7 +42,6 @@ Abstract store which can be subclassed\. To comply with \fBStore\fR you should d
#get(hash, callback) Fetch session data via the session fingerprint and callback(err, data)
#set(hash, data, callback) Commit the session for the fingerprint and callback(err)
-#destroy(hash, callback) Destroy the session associated with the fingerprint and callback(err, destroyedBoolean)
.
.fi
.
@@ -55,20 +54,22 @@ Your store may also want to comply with the default MemoryStore, by providing:
.
.nf
-#clear(callback) Clear all sessions
+#clear(callback) Clear all sessions and callback(err)
+#all(callback) Fetches all active sessions and callback(err, sessions)
#length(callback) Fetches the total number of sessions and callback(err, len)
.
.fi
.
.IP "" 0
.
.P
-Complimentary methods defined by Store:
+Inherited methods defined by Store:
.
.IP "" 4
.
.nf
+#destroy(hash, callback) Calls #set(hash, null, callback)
#regenerate(req, callback) Destroys the session, creates a new one, and callback(err)
.
.fi
View
9 docs/session.html
@@ -168,18 +168,19 @@ <h3 id="Store">Store</h3>
<pre><code>#get(hash, callback) Fetch session data via the session fingerprint and callback(err, data)
#set(hash, data, callback) Commit the session for the fingerprint and callback(err)
-#destroy(hash, callback) Destroy the session associated with the fingerprint and callback(err, destroyedBoolean)
</code></pre>
<p>Your store may also want to comply with the default MemoryStore, by providing:</p>
-<pre><code>#clear(callback) Clear all sessions
+<pre><code>#clear(callback) Clear all sessions and callback(err)
+#all(callback) Fetches all active sessions and callback(err, sessions)
#length(callback) Fetches the total number of sessions and callback(err, len)
</code></pre>
-<p>Complimentary methods defined by Store:</p>
+<p>Inherited methods defined by Store:</p>
-<pre><code>#regenerate(req, callback) Destroys the session, creates a new one, and callback(err)
+<pre><code>#destroy(hash, callback) Calls #set(hash, null, callback)
+#regenerate(req, callback) Destroys the session, creates a new one, and callback(err)
</code></pre>
<h3 id="MemoryStore">MemoryStore</h3>

0 comments on commit 2347316

Please sign in to comment.
Something went wrong with that request. Please try again.