resources/src/mediawiki.libs.jpegmeta/export.js

   1 /* global JpegMeta */
   2
   3 /**
   4  * Exposes a method for extracting metadata from JPEGs.
   5  *
   6  * @module mediawiki.libs.jpegmeta
   7  */
   8
   9 /**
  10  * Extract metadata from a JPEG.
  11  *
  12  * @example
  13  * const binReader = new FileReader();
  14  * binReader.onload = function () {
  15  *   const binStr = binReader.result;
  16  *   const jpegmeta = require( 'mediawiki.libs.jpegmeta' );
  17  *   const meta = jpegmeta( binStr, 'foo.jpg' );
  18  * }
  19  * binReader.readAsBinaryString( upload.file );
  20  *
  21  * @method (require("mediawiki.libs.jpegmeta"))
  22  * @param {string} fileReaderResult Binary string
  23  * @param {string} fileName
  24  * @return {Object} A {@link https://github.com/bennoleslie/jsjpegmeta JpegMeta.JpegFile} object
  25  */
  26 module.exports = function ( fileReaderResult, fileName ) {
  27         return new JpegMeta.JpegFile( fileReaderResult, fileName );
  28 };