grabity
Get preview data from a link. Just grab it! 🎣
Grabity looks through Open Graph and Twitter Cards markup to get Information about a link. Its functions will return as much data as they can from the markup. If no og or twitter tags are found, it will default to the content of the
tag and meta description, and if either the title tag or meta description is missing, the returned property will be empty.</p>
<h2>Getting Started:</h2>
<pre><code>npm install grabity</code></pre>
<h2>Usage:</h2>
<p>It's really quite simple:</p>
<pre><code class="language-javascript">let grabity = require("grabity");
(async () => {
let it = await grabity.grabIt("https://github.com/e-oj/grabity");
console.log(it);
})();</code></pre>
<p>Should produce:</p>
<pre><code>{
title: 'e-oj/grabity',
description: 'grabity - Get preview data from a link. Just grab it! 🎣',
image: 'https://avatars0.githubusercontent.com/u/9700116?s=400&v=4',
favicon: 'https://assets-cdn.github.com/favicon.ico'
}</code></pre>
<h2>API</h2>
<h3>grabity.grabIt(url): Gets a title, description, image, and favicon from a url</h3>
<blockquote>
<p>url (required): url to be used</p>
<p>returns: object containing title, description, image, and favicon if found</p>
</blockquote>
<p>Gets the <a rel="noreferrer nofollow" target="_blank" href="http://ogp.me/">og</a> or <a rel="noreferrer nofollow" target="_blank" href="https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup">twitter</a> title, description and image from a url, as well as the favicon, and returns them in an object. If <a rel="noreferrer nofollow" target="_blank" href="http://ogp.me/">og</a> and <a rel="noreferrer nofollow" target="_blank" href="https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup">twitter</a> tags exist for a property, the <a rel="noreferrer nofollow" target="_blank" href="http://ogp.me/">og</a> tag is given preference. The <a rel="noreferrer nofollow" target="_blank" href="https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup">twitter</a> tag is selected if an <a rel="noreferrer nofollow" target="_blank" href="http://ogp.me/">og</a> tag does not exist for a property. If there is no tag (<a rel="noreferrer nofollow" target="_blank" href="http://ogp.me/">og</a> or <a rel="noreferrer nofollow" target="_blank" href="https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup">twitter</a>) for a property, that property is not included in the returned object.</p>
<pre><code class="language-javascript">let grabity = require("grabity");
(async () => {
let it = await grabity.grabIt("https://www.flickr.com");
console.log(it);
})();</code></pre>
<p>result:</p>
<pre><code>{
title: 'Flickr, a Yahoo company',
description: 'Flickr is almost certainly the best online photo management and sharing application in the world. Show off your favorite photos and videos to the world, securely and privately show content to your friends and family, or blog the photos and videos you take with a cameraphone.',
image: 'https://farm4.staticflickr.com/3914/15118079089_489aa62638_b.jpg',
favicon: 'https://s.yimg.com/pw/favicon.ico'
}</code></pre>
<h3>grabity.grab(url): Gets all <a rel="noreferrer nofollow" target="_blank" href="http://ogp.me/">og</a> + <a rel="noreferrer nofollow" target="_blank" href="https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup">twitter</a> tags and their values, as well as the favicon,</h3>
<blockquote>
<p>url (required): url to be used</p>
<p>returns: object containing all found <a rel="noreferrer nofollow" target="_blank" href="http://ogp.me/">og</a> + <a rel="noreferrer nofollow" target="_blank" href="https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup">twitter</a> tags and values, and favicon</p>
</blockquote>
<p>Gets all existing <a rel="noreferrer nofollow" target="_blank" href="http://ogp.me/">og</a> and <a rel="noreferrer nofollow" target="_blank" href="https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup">twitter</a> tags, as well as the favicon, from the markup and returns them in an object.</p>
<pre><code class="language-javascript">let grabity = require("grabity");
(async () => {
let tags = await grabity.grab("https://www.flickr.com");
console.log(tags);
})();</code></pre>
<p>result:</p>
<pre><code>{
'og:site_name': 'Flickr',
'og:updated_time': '2017-11-19T21:29:36.577Z',
'og:title': 'Flickr, a Yahoo company',
'og:type': 'website',
'og:description': 'Flickr is almost certainly the best online photo management and sharing application in the world. Show off your favorite photos and videos to the world, securely and privately show content to your friends and family, or blog the photos and videos you take with a cameraphone.',
'og:image': 'https://farm4.staticflickr.com/3914/15118079089_489aa62638_b.jpg',
'twitter:card': 'summary_large_image',
'twitter:creator': '@flickr',
'twitter:title': 'Flickr, a Yahoo company',
'twitter:description': 'Flickr is almost certainly the best online photo management and sharing application in the world. Show off your favorite photos and videos to the world, securely and privately show content to your friends and family, or blog the photos and videos you take with a cameraphone.',
'twitter:image:src': 'https://farm4.staticflickr.com/3914/15118079089_489aa62638_b.jpg',
favicon: 'https://s.yimg.com/pw/favicon.ico'
}
</code></pre>
<p><br></p>
<h2>Test</h2>
<p>To test this module, cd to the project directory and run:</p>
<pre><code>npm run-script test-server</code></pre>
<p>then in a seperate terminal:</p>
<pre><code>npm test</code></pre>
<p><em>Note: The test server runs on port 9973 by default. You can change the port number in test_setup/config.js</em></p></div>
</div>
<div class="footer">
<ul class="body">
<li>© <script>
document.write(new Date().getFullYear())
</script> Githubissues.</li>
<li>Githubissues is a development platform for aggregating issues.</li>
</ul>
</div>
<script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js"></script>
<script src="/githubissues/assets/js.js"></script>
<script src="/githubissues/assets/markdown.js"></script>
<script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/highlight.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/languages/go.min.js"></script>
<script>
hljs.highlightAll();
</script>
</body>
</html>