Skip to content
Browse files

Updated docs, readme, and package.json

Everything all in order to publish to npm
  • Loading branch information...
1 parent fed4d2b commit b15aca4897f686c2a0981b8dc9b41426b97e6e11 @gamebox gamebox committed Jun 12, 2012
Showing with 735 additions and 1,099 deletions.
  1. +723 −1,077 docs/f2ee19a19f.html
  2. +6 −6 package.json
  3. +6 −16 readme.md
View
1,800 docs/f2ee19a19f.html
@@ -3,1860 +3,1506 @@
<head>
<meta charset="utf-8">
<title>JSDoc: Module: node-foursquare/Venues</title>
-
+
<script src="http://shjs.sourceforge.net/sh_main.min.js"> </script>
<script src="http://shjs.sourceforge.net/lang/sh_javascript.min.js"> </script>
-
+
<link type="text/css" rel="stylesheet" href="styles/node-dark.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
-
+
<h1 class="page-title">Module: node-foursquare/Venues</h1>
-
-
-
+
+
+
<section>
-
+
<header>
<h2>node-foursquare/Venues</h2>
-
- </header>
-
- <article>
+
+ </header>
+
+ <article>
<p class="description">A module for retrieving information about Venues from Foursquare.</p><dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 1</dd>
-
-
-
+
</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<h3 class="subsection-title">Methods</h3>
-
+
<dl>
<dt id="module:node-foursquare/Venues.explore">
<h4 class="name" id="explore"><span class="type-signature">&lt;static> </span>explore(lat, lng, [params], [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Explore Foursquare Venues.
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 39</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/venues/explore.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
-
+
+
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>lat</code></td>
-
-
+
+
<td class="type">
String | Number
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The latitude of the location around which to explore.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>lng</code></td>
-
-
+
+
<td class="type">
String | Number
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The longitude of the location around which to explore.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>params</code></td>
-
-
+
+
<td class="type">
Object
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
on currently supported parameters.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">The access token provided by Foursquare for the current user.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>callback</code></td>
-
-
+
+
<td class="type">
Function
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The function to call with results, function({Error} error, {Object} results).</td>
</tr>
-
-
</tbody>
</table>
-
-
-
-
-
-
-
-
</dd>
<dt id="module:node-foursquare/Venues.getCategories">
<h4 class="name" id="getCategories"><span class="type-signature">&lt;static> </span>getCategories([params], [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Retrieve a list of Venue Categories.
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 23</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/venues/categories.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
-
+
+
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>params</code></td>
-
-
+
+
<td class="type">
Object
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
on currently supported parameters.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">The access token provided by Foursquare for the current user.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>callback</code></td>
-
-
+
+
<td class="type">
Function
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The function to call with results, function({Error} error, {Object} results).</td>
</tr>
-
-
</tbody>
</table>
-
-
-
-
-
-
-
-
</dd>
<dt id="module:node-foursquare/Venues.getHereNow">
<h4 class="name" id="getHereNow"><span class="type-signature">&lt;static> </span>getHereNow(venueId, [params], [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Retrieve Check-ins for Users who are at a Venue "now".
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 163</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/venues/herenow.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
-
+
+
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>venueId</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The id of a Foursquare Venue.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>params</code></td>
-
-
+
+
<td class="type">
Object
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
on currently supported parameters.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">The access token provided by Foursquare for the current user.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>callback</code></td>
-
-
+
+
<td class="type">
Function
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The function to call with results, function({Error} error, {Object} results).</td>
</tr>
-
-
</tbody>
</table>
-
-
-
-
-
-
-
-
</dd>
<dt id="module:node-foursquare/Venues.getLinks">
<h4 class="name" id="getLinks"><span class="type-signature">&lt;static> </span>getLinks(venueId, [params], [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Retrieve Links for a Foursquare Venue.
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 235</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/venues/links.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
-
+
+
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>venueId</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The id of a Foursquare Venue.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>params</code></td>
-
-
+
+
<td class="type">
Object
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
- <td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
-on currently supported parameters.</td>
+
+
+
+
+ <td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
+on currently supported parameters.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">The access token provided by Foursquare for the current user.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>callback</code></td>
-
-
+
+
<td class="type">
Function
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The function to call with results, function({Error} error, {Object} results).</td>
</tr>
-
-
</tbody>
</table>
-
-
-
-
-
-
-
-
</dd>
<dt id="module:node-foursquare/Venues.getPhotos">
<h4 class="name" id="getPhotos"><span class="type-signature">&lt;static> </span>getPhotos(venueId, [group], [params], [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Retrieve Photos for a Foursquare Venue.
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 211</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/venues/photos.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
+
+
+
<th>Default</th>
-
-
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>venueId</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
+
+
+
<td class="default">
-
+
</td>
-
-
+
+
<td class="description last">The id of a Foursquare Venue.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>group</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
+
+
+
<td class="default">
"venue"
</td>
-
-
+
+
<td class="description last">The type of photos to retrieve. Refer to Foursquare documentation for details
on currently supported groups.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>params</code></td>
-
-
+
+
<td class="type">
Object
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
+
+
+
<td class="default">
-
+
</td>
-
-
+
+
<td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
on currently supported parameters.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
+
+
+
<td class="default">
-
+
</td>
-
-
+
+
<td class="description last">The access token provided by Foursquare for the current user. NOTE: This may or may
not be required for certain types of photos associated to the venue. Refer to the Foursquare documentation for
details.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>callback</code></td>
-
-
+
+
<td class="type">
Function
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
+
+
+
<td class="default">
-
+
</td>
-
-
+
+
<td class="description last">The function to call with results, function({Error} error, {Object} results).</td>
</tr>
-
-
</tbody>
</table>
-
-
-
-
-
-
-
-
</dd>
<dt id="module:node-foursquare/Venues.getTips">
<h4 class="name" id="getTips"><span class="type-signature">&lt;static> </span>getTips(venueId, [params], [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Retrieve Tips for a Foursquare Venue.
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 185</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/venues/tips.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
-
+
+
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>venueId</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The id of a Foursquare Venue.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>params</code></td>
-
-
+
+
<td class="type">
Object
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
on currently supported parameters.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">The access token provided by Foursquare for the current user.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>callback</code></td>
-
-
+
+
<td class="type">
Function
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The function to call with results, function({Error} error, {Object} results).</td>
</tr>
-
-
</tbody>
</table>
-
-
-
-
-
-
-
-
</dd>
<dt id="module:node-foursquare/Venues.getTrending">
<h4 class="name" id="getTrending"><span class="type-signature">&lt;static> </span>getTrending(lat, lng, [params], [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Return Foursquare Venues near location with the most people currently checked in.
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 89</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/venues/trending.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
-
+
+
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>lat</code></td>
-
-
+
+
<td class="type">
String | Number
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The latitude of the location around which to search.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>lng</code></td>
-
-
+
+
<td class="type">
String | Number
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The longitude of the location around which to search.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>params</code></td>
-
-
+
+
<td class="type">
Object
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
on currently supported parameters.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">The access token provided by Foursquare for the current user.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>callback</code></td>
-
-
+
+
<td class="type">
Function
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The function to call with results, function({Error} error, {Object} results).</td>
</tr>
-
-
</tbody>
</table>
-
-
-
-
-
-
-
-
</dd>
<dt id="module:node-foursquare/Venues.getVenue">
<h4 class="name" id="getVenue"><span class="type-signature">&lt;static> </span>getVenue(venueId, [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Retrieve a Foursquare Venue.
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 111</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/venues/venues.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
-
+
+
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>venueId</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The id of a Foursquare Venue.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">The access token provided by Foursquare for the current user.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>callback</code></td>
-
-
+
+
<td class="type">
Function
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The function to call with results, function({Error} error, {Object} results).</td>
</tr>
-
-
</tbody>
</table>
-
-
-
-
-
-
-
-
</dd>
<dt id="module:node-foursquare/Venues.getVenueAspect">
<h4 class="name" id="getVenueAspect"><span class="type-signature">&lt;static> </span>getVenueAspect(venueId, aspect, [params], [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Retrieve a specific aspect from the Venues endpoint.
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 135</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/index_docs.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
-
+
+
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>venueId</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The id of a Foursquare Venue.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>aspect</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The aspect to retrieve. Refer to Foursquare documentation for details on currently
supported aspects.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>params</code></td>
-
-
+
+
<td class="type">
Object
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
on currently supported parameters.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">The access token provided by Foursquare for the current user.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>callback</code></td>
-
-
+
+
<td class="type">
Function
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
+
+
+
+
<td class="description last">The function to call with results, function({Error} error, {Object} results).</td>
</tr>
-
-
</tbody>
</table>
-
-
-
-
-
-
-
-
</dd>
<dt id="module:node-foursquare/Venues.search">
- <h4 class="name" id="search"><span class="type-signature">&lt;static> </span>search(lat, lng, [params], [accessToken], callback)<span class="type-signature"></span></h4>
-
-
+ <h4 class="name" id="search"><span class="type-signature">&lt;static> </span>search(lat, lng, [near], [params], [accessToken], callback)<span class="type-signature"></span></h4>
+
+
</dt>
<dd>
-
-
+
+
<p class="description">
Search Foursquare Venues.
</p>
-
-
+
+
<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
<dt>Source:</dt>
<dd>/Users/clintandrewhall/Projects/node-foursquare/lib/venues.js, line 64</dd>
-
-
-
+
<dt>See:</dt>
<dd>
<ul><li>https://developer.foursquare.com/docs/venues/search.html</li></ul>
</dd>
-
+
</dl>
-
-
-
+
+
+
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
-
+
<th>Name</th>
-
-
+
+
<th>Type</th>
-
-
+
+
<th>Argument</th>
-
-
-
-
+
+
+
+
<th class="last">Description</th>
</tr>
</thead>
-
+
<tbody>
-
-
<tr>
-
+
<td class="name"><code>lat</code></td>
-
-
+
+
<td class="type">
String | Number
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
- <td class="description last">The latitude of the location around which to search.</td>
+
+
+
+
+ <td class="description last">The latitude of the location around which to search. Required along with lng if near is not specified.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>lng</code></td>
-
-
+
+
<td class="type">
String | Number
</td>
-
-
+
+
<td class="attributes">
-
+
</td>
-
-
-
-
- <td class="description last">The longitude of the location around which to search.</td>
+
+
+
+
+ <td class="description last">The longitude of the location around which to search. Required along with lat if near is not specified.</td>
</tr>
-
-
-
<tr>
-
+ <td class="name"><code>near</code></td>
+ <td class="type">
+ String
+ </td>
+ <td class="attributes">&lt;optional><br />
+ </td>
+ <td class="description last">The string representation of a location. Required if lng and lat are not specified. In "Anytown, CA" format.</td>
+ </tr>
+ <tr>
+
<td class="name"><code>params</code></td>
-
-
+
+
<td class="type">
Object
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">An object containing additional parameters. Refer to Foursquare documentation for details
on currently supported parameters.</td>
</tr>
-
-
-
+
<tr>
-
+
<td class="name"><code>accessToken</code></td>
-
-
+
+
<td class="type">
String
</td>
-
-
+
+
<td class="attributes">
&lt;optional><br>
</td>
-
-
-
-
+
+
+
+
<td class="description last">The access token provided by Foursquare for the current user.</td>
</tr>
-
-
-
+