Socket
Socket
Sign inDemoInstall

get-favicons

Package Overview
Dependencies
76
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    get-favicons

Extract the favicons URLs from a set of HTML head elements.


Version published
Weekly downloads
12
increased by1100%
Maintainers
1
Install size
1.57 MB
Created
Weekly downloads
 

Readme

Source

get-favicons Build Status

A promise to return a list of favicons contained in some HTML content.

The streaming approach helps remaining efficient in spite of malformed or very large HTML documents.

Notice: this module requires node>=4 to work.

Install

$ npm install --save get-favicons

Usage

Node API

const getFavicons = require('get-favicons');
const hyperquest = require('hyperquest');

const stream = hyperquest('http://www.bbc.com');

getFavicons(stream).then(icons => {
  // ...
});

You can also analyse a set of <head> tags provided as an array of objects (eg: like these provided by parse-head):

const getFavicons = require('get-favicons/from-array');

const headers = [ { nodeName: 'LINK', type: 'icon', href: '...'  }, ... ];

getFavicons(headers).then(icons => {
  // ...
});

Command line

Usage: cat some/file.html | get-favicons [options]

Options:
  --all       Return all the found favicons — not only the biggest ones.
                                                                       [boolean]
  --base-url  Use this given URL as a relative path against all found favicons
              paths.
  --ms-tile   Include msTile in the results.                           [boolean]
  --help      Show help                                                [boolean]

Examples:
  cat some/file.html | get-favicons -ms-tile --base-url http://example.com/foo/bar
  curl -Ss http://www.bbc.com | get-favicons

License

Copyright 2016, British Broadcasting Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Keywords

FAQs

Last updated on 23 Feb 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc