README

GMeta

A ridiculously lightweight metadata extractor for the given url or html

Installation

npm install gmeta --save

Usage from URL

const gmeta = require('gmeta');

// Using callback
gmeta(url,function(err,data){
    console.log(data);
});

// Using Promise (Async/Await) 
const response = await gmeta(url);
console.log(response);

Usage from HTML

const gmeta = require('gmeta');

// Using Callback
gmeta(html,function(err,data){
    console.log(data);
},true);

// Using Promise (Async/Await) 
const response = await gmeta(html,true);
console.log(response);

Example #1

const gmeta = require('gmeta');

const response = await gmeta('https://github.com');
console.log(response);
/* output =>
{ 
    description: 'GitHub brings together the world’s largest community of developers to discover, share, and build better software. From open source projects to private team repositories, we’re your all-in-one platform for collaborative development.',
    viewport: 'width=device-width',
    'google-site-verification': 'KT5gs8h0wvaagLKAVWq8bbeNwnZZK1r1XQysX3xurLU',
    'theme-color': '#1e2327',
    'fb:app_id': '1401488693436528',
    'og:url': 'https://github.com',
    'og:title': 'Build software better, together',
    'og:description': 'GitHub is where people build software. More than 28 million people use GitHub to discover, fork, and contribute to over 85 million projects.',
    'og:image': 'https://assets-cdn.github.com/images/modules/open_graph/github-logo.png',
    title: 'The world’s leading software development platform · GitHub',
    lang: 'en',
    icon: 'https://assets-cdn.github.com/favicon.ico',
    canonical: 'https://github.com/' 
}
*/
});

Example #2

const gmeta = require('gmeta');

let html = '<title>GitHub</title><meta name="description" content="GitHub is where people build software. More than 28 million people use GitHub to discover, fork, and contribute to over 85 million projects.">';

gmeta(html,function(err,data){
    console.log(data);
    /* output =>
    { description: 'GitHub is where people build software. More than 28 million people use GitHub to discover, fork, and contribute to over 85million projects.',
    title: 'GitHub' }
    */
},true);

API

gmeta(source, function(err, obj) {...},isHTML); - Callback Way

source (String): URL or HTML

callback (Function): Callback (err,obj)

isHTML Optional (Boolean [defaut:false]): if source is a HTML you need set it true

gmeta(source,isHTML); - Promise Way