Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s-leroux/feat-image
Find the featured image URL from a web page
https://github.com/s-leroux/feat-image
Last synced: about 1 month ago
JSON representation
Find the featured image URL from a web page
- Host: GitHub
- URL: https://github.com/s-leroux/feat-image
- Owner: s-leroux
- License: mit
- Created: 2018-09-27T21:53:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T18:56:44.000Z (over 1 year ago)
- Last Synced: 2024-10-31T16:58:46.579Z (2 months ago)
- Language: JavaScript
- Size: 236 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
feat-image
==========
Load the featured images and other metadata from a web page.
[](https://github.com/s-leroux/feat-image/actions/workflows/npm-test.yml)
## Installation
npm install --save feat-image
## Basic usage
```
const fi = require("feat-image");
const imageUrls = await fi(webPageUrl);
```
Load a web page and extract the URL for the featured images based on the
`meta` `og:image` and `twitter:image` tags. Duplicates are removed.
## Advanced usage
```
const fi = require("feat-image");
const about = await fi.about(webPageUrl);
console.log(url", about.url);
console.log("title", about.title);
console.log("description", about.description);
console.log("feature images", about.fi);
```
Load a web page and extract metadata based on open graph and twitter card data.
All attributes are returned as an array with duplicates removed.
## Example
```
const fi = require("feat-image");
const about = await fi.about("https://en.wikipedia.org/wiki/Ada_Lovelace");
console.dir(about);
{
fi: [
{
href: 'https://upload.wikimedia.org/wikipedia/commons/0/0b/Ada_Byron_daguerreotype_by_Antoine_Claudet_1843_or_1850.jpg',
width: 1200,
height: 1651
},
{
href: 'https://upload.wikimedia.org/wikipedia/commons/0/0b/Ada_Byron_daguerreotype_by_Antoine_Claudet_1843_or_1850.jpg',
width: 800,
height: 1101
},
{
href: 'https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/Ada_Byron_daguerreotype_by_Antoine_Claudet_1843_or_1850.jpg/640px-Ada_Byron_daguerreotype_by_Antoine_Claudet_1843_or_1850.jpg',
width: 640,
height: 880
}
],
url: [ 'https://en.wikipedia.org/wiki/Ada_Lovelace' ],
title: [ 'Ada Lovelace - Wikipedia' ],
description: []
}
```
## Node version
Require NodeJS >= v12.0
Tested with v12.0 and v14.15
## License
(The MIT License)
Copyright (c) 2018-2022 [Sylvain Leroux](mailto:[email protected])
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.