oust

August 20, 2023 · View on GitHub

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

Install

npm install oust -D

First include:

const oust = require('oust');

Resource links can then be extracted from either files:

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

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

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

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

const hrefs = oust(htmlString, 'preload');

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

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

const styles = oust(htmlString, 'styles');

const hrefs = oust(htmlString, ['preload', 'stylesheets']);

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

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

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

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

npm install --global oust

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

Usage:
  $ oust <filename> <type>

oust myFile.html stylesheets

oust myFile.html scripts

oust myFile.html imports

oust myFile.html links

oust myFile.html images