bbc/get-favicons

Name: get-favicons

Owner: BBC

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

Created: 2016-02-23 16:03:50.0

Updated: 2017-11-19 01:28:07.0

Pushed: 2016-09-23 14:35:12.0

Homepage: https://npmjs.com/get-favicons

Size: 9

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

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

m install --save get-favicons

Usage

Node API
t getFavicons = require('get-favicons');
t hyperquest = require('hyperquest');

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

avicons(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):

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

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

avicons(headers).then(icons => {
 ...

Command line
e: cat some/file.html | get-favicons [options]

ons:
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]

ples:
t some/file.html | get-favicons -ms-tile --base-url http://example.com/foo/bar
rl -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.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.