Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tj committed Jun 21, 2011
1 parent af6385f commit 652e166
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 8 deletions.
13 changes: 13 additions & 0 deletions docs/guide.html
Expand Up @@ -202,6 +202,7 @@
<li><a href="#req.accepts()">accepts()</a></li>
<li><a href="#req.is()">is()</a></li>
<li><a href="#req.param()">param()</a></li>
<li><a href="#req.get()">get()</a></li>
<li><a href="#req.flash()">flash()</a></li>
<li><a href="#req.isxmlhttprequest">isXMLHttpRequest</a></li>
</ul></li>
Expand Down Expand Up @@ -1082,6 +1083,18 @@ <h3 id="req.param()">req.param(name[, default])</h3>
should be an object. This can be done by using
the _express.bodyParser middleware.</p>

<h3 id="req.get()">req.get(field, param)</h3>

<p> Get <em>field</em>&rsquo;s <em>param</em> value, defaulting to &lsquo;&rsquo; when the <em>param</em>
or <em>field</em> is not present.</p>

<pre><code> req.get('content-disposition', 'filename');
// =&gt; "something.png"

req.get('Content-Type', 'boundary');
// =&gt; "--foo-bar-baz"
</code></pre>

<h3 id="req.flash()">req.flash(type[, msg])</h3>

<p>Queue flash <em>msg</em> of the given <em>type</em>.</p>
Expand Down
22 changes: 16 additions & 6 deletions docs/index.html
Expand Up @@ -239,19 +239,29 @@ <h2>Third-Party Modules</h2>
<li><a href="http://github.com/visionmedia/express-messages">express-messages</a> flash message notification rendering</li>
<li><a href="http://github.com/visionmedia/express-configuration">express-configure</a> async configuration support (load settings from redis etc)</li>
<li><a href="http://github.com/visionmedia/express-namespace">express-namespace</a> namespaced routing support</li>
<li><a href="http://github.com/visionmedia/express-expose">express-expose</a> expose</li>
<li><a href="https://github.com/visionmedia/express-params">express-params</a> param</li>
<li><a href="https://github.com/LearnBoost/express-mongoose">express-mongoose</a> plugin</li>
</ul>


<h2>More Information</h2>

<ul>
<li><a href="http://groups.google.com/group/express-js">Google Group</a> for discussion</li>
<li><h1>express on freenode</h1>

<p>objects, functions, modules and more to client-side js with ease
namespaced route support
pre-condition functions
for easy rendering of Mongoose async Query results</p></li>
<li>Follow <a href="http://twitter.com/tjholowaychuk">tjholowaychuk</a> on twitter for updates</li>
<li>View the <a href="http://senchalabs.github.com/connect">Connect</a> documentation</li>
<li>View the <a href="http://wiki.github.com/senchalabs/connect/">Connect Wiki</a> for contrib middleware</li>
<li>View the <a href="http://github.com/visionmedia/express/tree/master/examples/">examples</a></li>
<li>View the <a href="http://github.com/visionmedia/express">source</a></li>
<li>View the <a href="contrib.html">contrib guide</a></li>
<li><a href="http://groups.google.com/group/express-js">Google Group</a> for discussion</li>
<li>Visit the <a href="http://github.com/visionmedia/express/wiki">Wiki</a></li>
<li><a href="http://hideyukisaito.com/doc/expressjs/">日本語ドキュメンテーション</a> by <a href="https://github.com/hideyukisaito">hideyukisaito</a></li>
<li>Screencast &ndash; <a href="http://bit.ly/eRYu0O">Introduction</a></li>
<li>Screencast &ndash; <a href="http://bit.ly/dU13Fx">View Partials</a></li>
<li>Screencast &ndash; <a href="http://bit.ly/hX4IaH">Route Specific Middleware</a></li>
<li>Screencast &ndash; <a href="http://bit.ly/eNqmVs">Route Path Placeholder Preconditions</a></li>
</ul>

</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/migrate.html
Expand Up @@ -326,7 +326,7 @@ <h3>res.partial()</h3>

<h3>partial() locals</h3>

<p> Both <em>res.partial()</em> and the <em>partial()</em> functions accept an single object consisting of both the options and the locals. Previously with Express 1.x you may pass <em>user</em> to a partial, along with <em>date</em> like so:</p>
<p> Both <em>res.partial()</em> and the <em>partial()</em> functions accept a single object consisting of both the options and the locals. Previously with Express 1.x you may pass <em>user</em> to a partial, along with <em>date</em> like so:</p>

<pre><code> partial('user', { object: user, locals: { date: new Date }})
</code></pre>
Expand Down Expand Up @@ -367,7 +367,7 @@ <h3>Template Engine Compliance</h3>

<h3>View Partial Lookup</h3>

<p> Previously partials were loaded relative to the now removed <em>view partials</em> directory setting, or by default <em>views/partials</em>, now they are relative to the view calling them, read more on <a href="guide.html#View-Lookup">view lookup</a>.</p>
<p> Previously partials were loaded relative to the now removed <em>view partials</em> directory setting, or by default <em>views/partials</em>, now they are relative to the view calling them, read more on <a href="guide.html#view-lookup">view lookup</a>.</p>

<h3>Mime Types</h3>

Expand Down

0 comments on commit 652e166

Please sign in to comment.