JSPM – open-graph-collector@1.0.7

Package Exports

open-graph-collector

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (open-graph-collector) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Open Graph

The Open Graph protocol can be used to identify meta data on a website. This is commonly used on social media sites and messaging applications such as slack to show rich embedded objects from url links. To read more about Open Graph see here: opg.me.

Common meta data are things such as title, type, image and url.

Installation

npm install --save open-graph-collector

Usage

var openGraph = require('open-graph-collector');

openGraph('http://www.neogaf.com/forum/', (meta) => {
  console.log(meta);
});

The function takes a url and a callback.

The callback returns a meta data javascript literal object in its first parameter. If an error occured or no meta data was found, meta will be an empty javascript literal object.

Response

A typical and basic response will look like this:

{
  site_name: 'NeoGAF',
  type: 'website',
  image: 'http://www.neogaf.com/forum/images/neogaf2/icon_social.png',
  title: 'NeoGAF',
  url: 'http://www.neogaf.com/'
}

However, object could also be embedded, depending on how much information the html offers. An embedded object may look like:

{
  site_name: 'NeoGAF',
  type: 'website',
  image: {
    url: 'http://www.neogaf.com/forum/images/neogaf2/icon_social.png',
    width: '300',
    height: '300',
  },
  title: 'NeoGAF',
  url: 'http://www.neogaf.com/',
}

Dependencies

Once cloned/forked run:

npm install

Install gulp globally to run the gulp task runners

npm install -g gulp

Build

To test the project run:

$ gulp  or $ gulp test