url-meta-scraper

Get meta data from any url (http/https) and support group by property

Usage

Install

• With npm

1  npm install url-meta-scraper --save

• With yarn

1  yarn add url-meta-scraper --save

Example

• Basic

1  import { parser } from 'url-meta-scraper';
2  const metaData = await parser(url)

• If you'd like to override the default options:

1  import { parser } from 'url-meta-scraper';
2  const opts = {
3    maxRedirects: 10,
4    timeout: 10000,
5    userAgent: 'your-agent',
6    fromEmail: 'your-mail@example.com',
7  }
8  const metaData = await parser(url, opts)

Paramaters

1  // The url to get meta data
2  url: 'string',

Options

Package's default options are the values below, you can override it:

1{
2  // The package will follow a maximum of 10 redirects
3  maxRedirects: 10,
4  // Timeout of a request, default is 10 seconds:
5  timeout: 10000,
6  // The user agent and email that will make url request:
7  userAgent: 'Metadata',
8  fromEmail: 'metadata@example.com',
9}

Returns

Returns a promise that gets resolved with the following url metadata and group by properties tag if the url request response returns successfully.

1  {
2    // This is includes meta data of the meta without property
3    meta: {
4      title: 'title',
5      description: 'description',
6      ...
7    },
8    // This is includes meta data of the meta with property
9    og: {
10      title: 'title',
11      description: 'description',
12      ...
13    },
14    ...
15  }