node-pinboard
Version:
A Node.js wrapper for the Pinboard API.
214 lines (208 loc) • 11.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>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>
</ul>
<h1> node-pinboard</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#node-pinboard" id="node-pinboard" style="color: inherit; text-decoration: none;">
<h1>node-pinboard</h1>
</a>
<p><a href="https://www.npmjs.org/package/node-pinboard"><img src="https://img.shields.io/npm/v/node-pinboard.svg?style=flat-square" alt="npm package"></a>
<a href="https://travis-ci.org/maxmechanic/node-pinboard"><img src="https://travis-ci.org/maxmechanic/node-pinboard.svg?branch=master" alt="Build Status"></a></p>
<p>A Node.js wrapper for the Pinboard API.</p>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h3>Installation</h3>
</a>
<pre><code>npm install <span class="hljs-keyword">node</span><span class="hljs-title">-pinboard</span></code></pre>
<a href="#available-functions" id="available-functions" style="color: inherit; text-decoration: none;">
<h3>Available functions</h3>
</a>
<p>node-pinboard follows the <a href="https://pinboard.in/api/">Pinboard v1 API</a> with <a href="https://pinboard.in/api/#authentication">token auth</a> (token can be found on <a href="https://pinboard.in/settings/password">settings/password</a>).</p>
<a href="#errors" id="errors" style="color: inherit; text-decoration: none;">
<h3>Errors</h3>
</a>
<p>Under the hood, node-pinboard uses node-fetch, so API call errors will follow that library's patterns.</p>
<a href="#tests" id="tests" style="color: inherit; text-decoration: none;">
<h3>Tests</h3>
</a>
<pre><code>npm <span class="hljs-built_in">test</span></code></pre><p>To determine code coverage:</p>
<pre><code>npm <span class="hljs-keyword">run</span><span class="bash"> coverage</span></code></pre>
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
<h3>Examples</h3>
</a>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> Pinboard = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-pinboard'</span>).default;
<span class="hljs-keyword">const</span> api_token = <span class="hljs-string">'user:NNNNNN'</span>;
<span class="hljs-keyword">const</span> pinboard = <span class="hljs-keyword">new</span> Pinboard(api_token);
<span class="hljs-keyword">const</span> options = {
<span class="hljs-attr">url</span>: <span class="hljs-string">'https://github.com/maxmechanic/node-pinboard'</span>,
<span class="hljs-attr">description</span>: <span class="hljs-string">'node pinboard'</span>,
<span class="hljs-attr">tags</span>: <span class="hljs-string">'github,node-pinboard,test'</span>,
<span class="hljs-attr">toread</span>: <span class="hljs-string">'yes'</span>
};
pinboard.add(options, (err, res) => {
<span class="hljs-built_in">console</span>.log(res);
<span class="hljs-comment">//{ result_code: 'done' }</span>
});
pinboard.get({ <span class="hljs-attr">tag</span>: <span class="hljs-string">'node-pinboard'</span> }, (err, res) => {
<span class="hljs-built_in">console</span>.log(res);
<span class="hljs-comment">//date: date,</span>
<span class="hljs-comment">//user: 'user',</span>
<span class="hljs-comment">//posts:</span>
<span class="hljs-comment">//[ { href: 'https://github.com/maxmechanic/node-pinboard',</span>
<span class="hljs-comment">//description: 'node pinboard',</span>
<span class="hljs-comment">//extended: '',</span>
<span class="hljs-comment">//meta: 'meta',</span>
<span class="hljs-comment">//hash: 'hash',</span>
<span class="hljs-comment">//time: 'time',</span>
<span class="hljs-comment">//shared: 'no',</span>
<span class="hljs-comment">//toread: 'yes',</span>
<span class="hljs-comment">//tags: 'git node-pinboard test' } ] }</span>
});
<span class="hljs-comment">// promise version</span>
pinboard.get({ <span class="hljs-attr">tag</span>: <span class="hljs-string">'node-pinboard'</span> }).then(<span class="hljs-function"><span class="hljs-params">res</span> =></span> {
<span class="hljs-built_in">console</span>.log(res);
});</code></pre>
</div>
</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=" 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>
</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>