node-pinboard
Version:
A Node.js wrapper for the Pinboard API.
612 lines • 34 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Pinboard | node-pinboard</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">node-pinboard</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_index_.html">"index"</a>
</li>
<li>
<a href="_index_.pinboard.html">Pinboard</a>
</li>
</ul>
<h1>Class Pinboard</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Pinboard</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_index_.pinboard.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#add" class="tsd-kind-icon">add</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#all" class="tsd-kind-icon">all</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#api_token" class="tsd-kind-icon">api_<wbr>token</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#dates" class="tsd-kind-icon">dates</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#get" class="tsd-kind-icon">get</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#gettags" class="tsd-kind-icon">get<wbr>Tags</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#recent" class="tsd-kind-icon">recent</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#renametag" class="tsd-kind-icon">rename<wbr>Tag</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#token" class="tsd-kind-icon">token</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#update" class="tsd-kind-icon">update</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.pinboard.html#usersecret" class="tsd-kind-icon">user<wbr>Secret</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.pinboard.html#deltag" class="tsd-kind-icon">del<wbr>Tag</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.pinboard.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.pinboard.html#getnote" class="tsd-kind-icon">get<wbr>Note</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.pinboard.html#listnotes" class="tsd-kind-icon">list<wbr>Notes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.pinboard.html#suggest" class="tsd-kind-icon">suggest</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Pinboard<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.pinboard.html" class="tsd-signature-type">Pinboard</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L25">index.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Uses token available on <a href="https://pinboard.in/settings/password">settings/password</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>token: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.pinboard.html" class="tsd-signature-type">Pinboard</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="add" class="tsd-anchor"></a>
<h3>add</h3>
<div class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('posts/add', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L39">index.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Add a bookmark.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="all" class="tsd-anchor"></a>
<h3>all</h3>
<div class="tsd-signature tsd-kind-icon">all<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('posts/all', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L67">index.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns all bookmarks in the user's account.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="api_token" class="tsd-anchor"></a>
<h3>api_<wbr>token</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('user/api_token', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L102">index.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the user's API token (for making API calls without a password)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="dates" class="tsd-anchor"></a>
<h3>dates</h3>
<div class="tsd-signature tsd-kind-icon">dates<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('posts/dates', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L57">index.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a list of dates with the number of posts at each date.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="get" class="tsd-anchor"></a>
<h3>get</h3>
<div class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('posts/get', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L52">index.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns one or more posts on a single day matching the arguments.
If no date or url is given, date of most recent bookmark will be used.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="gettags" class="tsd-anchor"></a>
<h3>get<wbr>Tags</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Tags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('tags/get', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L80">index.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a full list of the user's tags along with the number of times they were used.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="recent" class="tsd-anchor"></a>
<h3>recent</h3>
<div class="tsd-signature tsd-kind-icon">recent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('posts/recent', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L62">index.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a list of the user's most recent posts, filtered by tag.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="renametag" class="tsd-anchor"></a>
<h3>rename<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">rename<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('tags/rename', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L92">index.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Rename an tag, or fold it in to an existing tag</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="token" class="tsd-anchor"></a>
<h3>token</h3>
<div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L29">index.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="update" class="tsd-anchor"></a>
<h3>update</h3>
<div class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('posts/update', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L34">index.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns The most recent time a bookmark was added, updated or deleted.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="usersecret" class="tsd-anchor"></a>
<h3>user<wbr>Secret</h3>
<div class="tsd-signature tsd-kind-icon">user<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = pinboardMethod('user/secret', this.token)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L97">index.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the user's secret RSS key (for viewing private feeds)</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="deltag" class="tsd-anchor"></a>
<h3>del<wbr>Tag</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">del<wbr>Tag<span class="tsd-signature-symbol">(</span>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L85">index.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Delete an existing tag.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tag: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>cb: <span class="tsd-signature-type">Callback</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="delete" class="tsd-anchor"></a>
<h3>delete</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L44">index.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Delete a bookmark.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>cb: <span class="tsd-signature-type">Callback</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getnote" class="tsd-anchor"></a>
<h3>get<wbr>Note</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Note<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L114">index.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns an individual user note. The hash property is a 20 character long sha1 hash of the note text.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>cb: <span class="tsd-signature-type">Callback</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="listnotes" class="tsd-anchor"></a>
<h3>list<wbr>Notes</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">list<wbr>Notes<span class="tsd-signature-symbol">(</span>cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L107">index.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a list of the user's notes</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>cb: <span class="tsd-signature-type">Callback</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="suggest" class="tsd-anchor"></a>
<h3>suggest</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">suggest<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/maxmechanic/node-pinboard/blob/c5e9ce8/lib/index.ts#L73">index.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a list of popular tags and recommended tags for a given URL.
Popular tags are tags used site-wide for the url; recommended tags are drawn from the user's own tags.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>cb: <span class="tsd-signature-type">Callback</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_index_.html">"index"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_index_.pinboard.html" class="tsd-kind-icon">Pinboard</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_index_.pinboard.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#add" class="tsd-kind-icon">add</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#all" class="tsd-kind-icon">all</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#api_token" class="tsd-kind-icon">api_<wbr>token</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#dates" class="tsd-kind-icon">dates</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#get" class="tsd-kind-icon">get</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#gettags" class="tsd-kind-icon">get<wbr>Tags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#recent" class="tsd-kind-icon">recent</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#renametag" class="tsd-kind-icon">rename<wbr>Tag</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#token" class="tsd-kind-icon">token</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#update" class="tsd-kind-icon">update</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.pinboard.html#usersecret" class="tsd-kind-icon">user<wbr>Secret</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.pinboard.html#deltag" class="tsd-kind-icon">del<wbr>Tag</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.pinboard.html#delete" class="tsd-kind-icon">delete</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.pinboard.html#getnote" class="tsd-kind-icon">get<wbr>Note</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.pinboard.html#listnotes" class="tsd-kind-icon">list<wbr>Notes</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.pinboard.html#suggest" class="tsd-kind-icon">suggest</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>