Nostalgic Primordial Monster

    link-meta-extractor
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.3 • Public • Published

    GitHub Workflow Status (branch) npm

    link-meta-extractor

    Extract metadata information from any http/https url. Simply pass a url string to the function and wait for the metadata results. You can run the code with async/await or use a callback to get results.


    Installation

    npm install link-meta-extractor

    TypeScript Usage

    Work with async/await

    If you want to extract metadata information from a website using async/await then go with following code...

    import { extractMetadata } from 'link-meta-extractor';
    
    async function extractMeta() {
      const url = 'https://stackblogger.com';
      const metaInformation = await extractMetadata(url);
    
      console.log(metaInformation);
    }
    
    extractMeta();
    
    /*
        {
            title: 'StackBlogger - A blog by programmer for programmers',
            description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
            banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
            isItWordpress: true,
            wordpressVersion: 'WordPress 5.8.1'
        }
    */

    Work with promise/callback

    If you want to extract metadata information from a website using callback method then go with following code...

    import { extractMetadata } from 'link-meta-extractor';
    
    function extractMeta() {
      const url = 'https://stackblogger.com';
      extractMetadata(url).then((metaInformation) => {
        console.log(metaInformation);
      });
    }
    
    extractMeta();
    
    /*
        {
            title: 'StackBlogger - A blog by programmer for programmers',
            description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
            banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
            isItWordpress: true,
            wordpressVersion: 'WordPress 5.8.1'
        }
    */

    JavaScript Usage

    Use the following code to extract metadata information from an url in JavaScript code

    Work with async/await

    If you want to extract metadata information from a website using async/await then go with following code...

    const metaExtractor = require('link-meta-extractor');
    
    async function extractMeta() {
      const url = 'https://stackblogger.com';
      const metaInformation = await metaExtractor.extractMetadata(url);
      console.log(metaInformation);
    }
    
    extractMeta();
    
    /*
        {
            title: 'StackBlogger - A blog by programmer for programmers',
            description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
            banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
            isItWordpress: true,
            wordpressVersion: 'WordPress 5.8.1'
        }
    */

    Work with promise/callback

    If you want to extract metadata information from a website using callback method then go with following code...

    const metaExtractor = require('link-meta-extractor');
    
    function extractMeta() {
      const url = 'https://stackblogger.com';
      metaExtractor.extractMetadata(url).then((metaInformation) => {
        console.log(metaInformation);
      });
    }
    
    extractMeta();
    
    /*
        {
            title: 'StackBlogger - A blog by programmer for programmers',
            description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
            banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
            isItWordpress: true,
            wordpressVersion: 'WordPress 5.8.1'
        }
    */

    Additional Fields Extraction

    The plugin accepts additional fields as optional argument that you can use to extract from a website.

    Pass the meta field keys in string format as a rest parameter in function. Refer the code here...

    import { extractMetadata } from 'link-meta-extractor';
    
    async function extractMeta() {
      const url = 'https://stackblogger.com';
      const metaInformation = await extractMetadata(
        url,
        'og:site_name', // additional field
        'og:image', // additional field
        'robots' // additional field
      );
    
      console.log(metaInformation);
    }
    
    extractMeta();
    
    /* 
        {
            title: 'StackBlogger - A blog by programmer for programmers',
            description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
            banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
            isItWordpress: true,
            wordpressVersion: 'WordPress 5.8.1',
            additional: {
                siteName: 'StackBlogger',
                image: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
                robots: 'index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1'
            }
        }
    */

    License

    MIT

    Install

    npm i link-meta-extractor

    DownloadsWeekly Downloads

    14

    Version

    1.3.3

    License

    ISC

    Unpacked Size

    16.9 kB

    Total Files

    16

    Last publish

    Collaborators

    • jimcute