/oust

Extract URLs to stylesheets, scripts, links, images or HTML imports from HTML

Primary LanguageJavaScriptApache License 2.0Apache-2.0

oust Build Status

Extract URLs to stylesheets, scripts, links, images or HTML imports from HTML

Install

$ npm install --save-dev oust

Usage

First include:

var oust = require('oust');

Resource links can then be extracted from either files:

Extract stylesheets references <link rel="stylesheet">

var hrefs = oust(htmlString, 'stylesheets');

Extract stylesheets references with media print <link rel="stylesheet" media="print">

var hrefs = oust(htmlString, 'stylesheets', function(i, $el) {
    return $el.attr('media') === 'print';
});

Extract script references <script src>

var srcs = oust(htmlString, 'scripts');

Extract HTML imports <link rel="import">

var hrefs = oust(htmlString, 'imports');

Extract URL references <a href>

var srcs = oust(htmlString, 'links');

Extract image source references <img src>

var srcs = oust(htmlString, 'images');

Extract cheerio elements alongside the value

Usefull for post processing/filtering as you get an array of matched elements with cheerio convenience syntax (e.g. $el.attr())

var srcs = oust.raw(htmlString, '...');

 -> [
    {value: '...', $el: '...'},
    {value: '...', $el: '...'},
    ...
 ]

API

Options

Attribute Default Description
src `` a valid HTML string to parse for references
type `` one of stylesheets, scripts, imports, links, images

CLI

$ npm install --global oust
Extract URLs to stylesheets, scripts, links, images or HTML imports from HTML

Usage:
    $ oust <filename> <type>

Extract stylesheets references <link rel="stylesheet">

$ oust myFile.html stylesheets

Extract script references <script src>

$ oust myFile.html scripts

Extract HTML imports <link rel="import">

$ oust myFile.html imports

Extract URL references <a href>

$ oust myFile.html links

Extract image source references <img src>

$ oust myFile.html images

License

Released under an Apache 2 license. © Google 2014.