@file-type/xml

Detector plugin for file-type for XML files.

Installation

npm install @file-type/xml

Usage

The following example shows how to add the XML detector to file-type.

import {FileTypeParser} from 'file-type';
import {detectXml} from '@file-type/xml';

const parser = new FileTypeParser({customDetectors: [detectXml]});
const fileType = await parser.fromFile('example.kml');
console.log(fileType);

With file-type 22, Node.js 22 or newer is required. For stream detection, pass a web ReadableStream to parser.fromStream(). Convert a Node.js Readable with Readable.toWeb():

import {createReadStream} from 'node:fs';
import {Readable} from 'node:stream';

const fileType = await parser.fromStream(Readable.toWeb(createReadStream('example.kml')));

The detector inspects at most 16 KiB, including any byte order mark. To change this limit, create a detector with a sampleSize in bytes:

import {FileTypeParser} from 'file-type';
import {createXmlDetector} from '@file-type/xml';

const parser = new FileTypeParser({
    customDetectors: [createXmlDetector({sampleSize: 64 * 1024})]
});

The limit applies to both prolog detection and XML parsing. If no XML signature is found within the sample, the detector returns undefined without consuming input. If XML is recognized but its specific format cannot be determined within the sample, it returns application/xml. sampleSize must be a positive safe integer. The file-type stream sampling option is separate; when using fileTypeStream, set its sampleSize as well if you want a larger sample.

You can also use the XML detector outside file-type:

import {XmlTextDetector} from '@file-type/xml';

const xmlTextDetector = new XmlTextDetector();
xmlTextDetector.write('<svg xmlns="http://www.w3.org/2000/svg"><path fill="#00CD9F"/></svg>');
const fileType = xmlTextDetector.fileType;
console.log(JSON.stringify(fileType)); // Outputs: {"ext":"svg","mime":"image/svg+xml"}

Support file formats

• XML (default for XML, unless a more specific format was detected)
• Apple Property list, .plist
• Atom
• DocBook
• GML (Geography Markup Language)
• GPX (GPS Exchange Format)
• KML (Keyhole Markup Language)
• MathML (Mathematical Markup Language)
• MusicXML, Uncompressed
• OPML (Outline Processor Markup Language)
• RSS (RDF Site Summary or Really Simple Syndication)
• SMIL: (Synchronized Multimedia Integration Language)
• SVG: (Scalable Vector Graphics)
• TEI, Text Encoding Initiative
• TTML: (Timed Text Markup Language)
• X3D (Extensible 3D)
• XHTML
• XLIFF (XML Localization Interchange File Format)

Licence

This project is licensed under the MIT License. Feel free to use, modify, and distribute as needed.