metascraper-logo-favicon

metascraper-logo-favicon: Metascraper logo favicon fallback.

See our website for more information.

Install

``bash
$ npm install metascraper-logo-favicon --save
`

API

$3

#### options

##### favicon

Type: boolean

Default: true

It tries to resolve favicon.ico of the url.

##### google

Type: boolean

Default: true

It enables logo resolution using Google API.

##### gotOpts

Type: object

Any option provided here will passed to got#options.

##### keyvOpts

Type: object

Any option provided here will passed to @keyvhq/memoize#options.

##### pickFn

Type: function

It will be used for picking the value to extract from a set of favicon detected on the markup.

`js
const pickFn = (sizes, { pickDefault }) => {
const appleTouchIcon = sizes.find((item) => item.rel.includes('apple'))
return (appleTouchIcon || pickDefault(sizes)).url
}

const metascraper = require('metascraper')([
require('metascraper-logo-favicon')({
pickFn
})
])
`

If you don't specific it, the favicon with the bigger size will be picked.

##### resolveFaviconUrl

Type: function

It will be used to determine if a favicon URL is valid.

##### rootFavicon

Type: boolean|regexp

Default: true

It tries to resolve favicon.ico` of the url when the URL is a subdomain.

License

metascraper-logo-favicon © Microlink, released under the MIT License.

Authored and maintained by Microlink with help from contributors.

> microlink.io · GitHub microlinkhq · X @microlinkhq