https://github.com/rocktimsaikia/meta-fetcher

Simple metadata scrapper for node.js
https://github.com/rocktimsaikia/meta-fetcher

meta-data meta-data-fetcher meta-fetcher metadata-extractor metadata-scrapper url-metadata

Last synced: 10 days ago
JSON representation

Simple metadata scrapper for node.js

• Host: GitHub
• URL: https://github.com/rocktimsaikia/meta-fetcher
• Owner: rocktimsaikia
• Created: 2020-09-12T14:18:00.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-01-27T15:49:22.000Z (10 months ago)
• Last Synced: 2024-09-25T16:53:56.282Z (about 1 month ago)
• Topics: meta-data, meta-data-fetcher, meta-fetcher, metadata-extractor, metadata-scrapper, url-metadata
• Language: TypeScript
• Homepage: https://npm.im/meta-fetcher
• Size: 184 KB
• Stars: 151
• Watchers: 8
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• my-awesome-list - meta-fetcher

README

        
# meta-fetcher

[![CI](https://github.com/rocktimsaikia/meta-fetcher/actions/workflows/main.yml/badge.svg)](https://github.com/rocktimsaikia/meta-fetcher/actions/workflows/main.yml)

![npm](https://img.shields.io/npm/v/meta-fetcher?style=flat&color=success&logo=npm)

Simple metadata scrapper.

## Installation

```sh

yarn add meta-fetcher

```

## Usage

```js

import metaFetcher from 'meta-fetcher';

const result = await metaFetcher('https://hoppscotch.io/');

console.log(result);

```

Output:

```json

{

  "title": "Hoppscotch - Open source API development ecosystem",

  "description": "Helps you create requests faster, saving precious time on development.",

  "image": "https://hoppscotch.io/og.png",

  "url": "https://hoppscotch.io/",

  "siteName": "Hoppscotch",

  "type": "website"

}

```

## API

### metaFetcher(input)

Takes one url string as a parameter and returns an object containing the meta-information.

#### input

type: `string` \

default: `'none'`

The url string to be scrapped.

## Related

[**page-scrapper**](https://github.com/rocktimsaikia/page-scrapper): Node.js scrapper that pulls out all links and images of a given site.

## License

2024 [MIT](https://choosealicense.com/licenses/mit/) © [Rocktim Saikia](https://rocktimsaikia.dev)