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

1npm 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...

1import { extractMetadata } from 'link-meta-extractor';
2
3async function extractMeta() {
4  const url = 'https://stackblogger.com';
5  const metaInformation = await extractMetadata(url);
6
7  console.log(metaInformation);
8}
9
10extractMeta();
11
12/*
13    {
14        title: 'StackBlogger - A blog by programmer for programmers',
15        description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
16        banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
17        isItWordpress: true,
18        wordpressVersion: 'WordPress 5.8.1'
19    }
20*/

Work with promise/callback

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

1import { extractMetadata } from 'link-meta-extractor';
2
3function extractMeta() {
4  const url = 'https://stackblogger.com';
5  extractMetadata(url).then((metaInformation) => {
6    console.log(metaInformation);
7  });
8}
9
10extractMeta();
11
12/*
13    {
14        title: 'StackBlogger - A blog by programmer for programmers',
15        description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
16        banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
17        isItWordpress: true,
18        wordpressVersion: 'WordPress 5.8.1'
19    }
20*/

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...

1const metaExtractor = require('link-meta-extractor');
2
3async function extractMeta() {
4  const url = 'https://stackblogger.com';
5  const metaInformation = await metaExtractor.extractMetadata(url);
6  console.log(metaInformation);
7}
8
9extractMeta();
10
11/*
12    {
13        title: 'StackBlogger - A blog by programmer for programmers',
14        description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
15        banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
16        isItWordpress: true,
17        wordpressVersion: 'WordPress 5.8.1'
18    }
19*/

Work with promise/callback

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

1const metaExtractor = require('link-meta-extractor');
2
3function extractMeta() {
4  const url = 'https://stackblogger.com';
5  metaExtractor.extractMetadata(url).then((metaInformation) => {
6    console.log(metaInformation);
7  });
8}
9
10extractMeta();
11
12/*
13    {
14        title: 'StackBlogger - A blog by programmer for programmers',
15        description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
16        banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
17        isItWordpress: true,
18        wordpressVersion: 'WordPress 5.8.1'
19    }
20*/

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...

1import { extractMetadata } from 'link-meta-extractor';
2
3async function extractMeta() {
4  const url = 'https://stackblogger.com';
5  const metaInformation = await extractMetadata(
6    url,
7    'og:site_name', // additional field
8    'og:image', // additional field
9    'robots' // additional field
10  );
11
12  console.log(metaInformation);
13}
14
15extractMeta();
16
17/* 
18    {
19        title: 'StackBlogger - A blog by programmer for programmers',
20        description: 'StackBlogger provide programming Tutorials, Tips, Tricks and HowTo Guides.',
21        banner: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
22        isItWordpress: true,
23        wordpressVersion: 'WordPress 5.8.1',
24        additional: {
25            siteName: 'StackBlogger',
26            image: 'https://stackblogger.com/wp-content/uploads/2021/10/Untitled-7-1.png',
27            robots: 'index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1'
28        }
29    }
30*/

License

MIT