New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

doc-sniff

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

doc-sniff

A helper for combating incorrect content-type, aka a mime sniffing module for node.js

0.1.0
Source
npm

Version published: 10 years ago

Weekly downloads: 976; decreased by-27.22%

Maintainers: 1

Weekly downloads

Created: 10 years ago

Source

doc-sniff

A helper for combating incorrect content-type, aka a mime sniffing module for node.js

Motivation

So you have made a http request and got back some headers and a response body, but you just don't know if that innocent Content-Type header tells you what really goes on in its body.

Enter doc-sniff, a simple node.js implementation of whatwg mime sniffing algorithm. Specifically for those responses that can't be easily distinguished via file extensions or magic numbers, eg. HTML, XML documents.

Install

npm install doc-sniff --save

Usage

var docsniff = require('doc-sniff');

var mime1 = docsniff(false, '<html></html>');
console.log(mime1); // text/html

var mime2 = docsniff('text/html', '<?xml version="1.0" encoding="UTF-8" ?><feed></feed>');
console.log(mime2); // application/atom+xml

var mime3 = docsniff('application/xml; charset=UTF-8', '<?xml version="1.0" encoding="UTF-8" ?><feed></feed>');
console.log(mime3); // application/xml

Currently this module will correct following mime:

text/html
text/xml
text/plain
application/xml
application/rss+xml
application/atom+xml
application/rdf+xml
application/octet-stream

It does not attempt to be overzealous at correcting subtypes; see example 3 above, if original mime is acceptable, it will not be replaced.

API

docsniff(type, body);

type is the content-type header in response
body is the response body string

Limits

Whatwg spec has a much more thorough mime list for browser vendors, but on server-side, we are more interested in parsable documents, if you encounter a use case not covered by this algorithm, let us know at github issues.

Like any algorithm, this can be spoofed, so don't use it for validation, use it for mime sniffing only.

License

MIT

Keywords

FAQs

What is doc-sniff?

Is doc-sniff popular?

Is doc-sniff well maintained?

Package last updated on 29 Jan 2015

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