Code Monkey home page Code Monkey logo

meta-scraper's Introduction

Meta tag Scraper

Retrieves the meta tags from a given web page. Common tag values (title, description, e.g.) are returned as object properties. There is also an allTags property which is an array of objects that contain the values of all the meta tags for the page.

Install

npm install meta-scraper --save

Usage

// ES5 require
const metaScraper = require('meta-scraper').default;
// ES6 import
import metaScraper from 'meta-scraper';

// Returns a promise. 
metaScraper('https://facebook.com')
  .then(function(data) {
    console.log(data);
    /*
      { 
        error: false,
        allTags: [ 
          { charset: 'utf-8' },
          { name: 'referrer', content: 'default', id: 'meta_referrer'},
          { property: 'og:site_name', content: 'Facebook' }
          ...more tags
        ],
        pageTitle: 'Facebook - Log In or Sign Up',
        pubDate: false,
        title: 'Facebook - Log In or Sign Up',
        description: 'Create an account or log into Facebook. Connect with friends, family and other people you know. Share photos and videos, send messages and get updates.',
        image: 'https://www.facebook.com/images/fb_icon_325x325.png'
      }
    */
  });

Available Properties

There are a number properties that are provided along with reasonable fallbacks:

  • title: Tries to first get the Open Graph or Twitter card title and uses pageTitle as a fallback.
  • pageTitle: The document title. This will be false if document title is missing.
  • description: Tries to first get the Open Graph or Twitter card description and uses the meta description as a fallback. This will be false if none of those are present.
  • pubDate: Tries to use article:published_time first, then og:pubdate as a fallback. This is false if those aren't available.
  • image: Tries to first get the Open Graph or Twitter card image. If those aren't available, this is false.
  • og: All available Open Graph tags. If those aren't available, this is false.
  • twitter: All available Twitter tags. If those aren't available, this is false.
  • error: If error is set to true, then there will be an additional property available, errorMessage, that will have the error message.
  • allTags: This is an array of objects. Each object contains the attributes for the meta tags and all of the page's meta tags should be available on this property. Using Array.filter() would be a useful way to find any tags that aren't provided by default. See the example below.
// If we have an object named 'data' returned when the promise resolves, we can get theme color:
const themeColor = data.allTags.filter(item => item.name && item.name === 'theme-color')[0].content;

meta-scraper's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.