head-parser

parse the <head> of documents for <title>, <meta>, and <link>s

npm install head-parser
2 downloads in the last week
10 downloads in the last month

Head Parser

Parse the <head> of documents to get the <title>, <meta, and <link> elements.

Example

var parse = require('head-parser')
var request = require('request')

var req = request('https://github.com/')
parse(req, function (err, res) {
  req.destroy() // destroy the request since we only need to read the <head>
  res.title === 'GitHub ยท Build software better, together.'
  res.meta[0] === {
    charset: 'utf-8'
  }
  res.links[0] === {
    rel: 'search',
    type: 'application/opensearchdescription+xml',
    href: '/opensearch.xml',
    title: 'GitHub'
  }
})

API

parse(stream, done)

Parses the stream. Since it only reads the <head> of the stream, you can destroy it once the callback is executed.

done returns:

  • err - streams's errors are propagated here until done is executed. Also returns any parsing errors while parsing the <head>.
  • obj - An object with the results:
    • title - the <title> of the document, if any
    • meta[] - an array of meta element attributes
    • links[] - an array of link element attributes

License

The MIT License (MIT)

Copyright (c) 2014 Jonathan Ong me@jongleberry.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you