exiftool-vendored 33.4.0 → 34.0.0

package/dist/ExifToolOptions.d.ts

@@ -14,24 +14,24 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
     /**
      * The maximum number of ExifTool child processes to spawn when load merits.
      *
-     * Defaults to 1/4 the number of CPUs, minimally 1.
+     * @default `Math.max(1, Math.floor(os.cpus().length / 4))`
      */
     maxProcs: number;
     /**
      * The maximum number of requests a given ExifTool process will service
      * before being retired.
      *
-     * Defaults to 500, to balance performance with memory usage.
+     * @default 500
      */
     maxTasksPerProcess: number;
     /**
-     * Spawning new ExifTool processes must not take longer than
-     * {@link spawnTimeoutMillis} milliseconds before the child process is timed
-     * out and a new attempt is made. Be pessimistic here--windows can regularly
-     * take several seconds to spin up a process, thanks to antivirus
-     * shenanigans. This can't be set to a value less than 100ms.
+     * Spawning new ExifTool processes must not take longer than this before the
+     * child process is timed out and a new attempt is made. Be pessimistic
+     * here--windows can regularly take several seconds to spin up a process,
+     * thanks to antivirus shenanigans. This can't be set to a value less than
+     * 100ms.
      *
-     * Defaults to 30 seconds, to accommodate slow Windows machines.
+     * @default 30000 (30 seconds)
      */
     spawnTimeoutMillis: number;
     /**
@@ -39,49 +39,54 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * process is dead and we should restart the task. This can't be set to a
      * value less than 10ms, and really should be set to at more than a second
      * unless `taskRetries` is sufficiently large or all writes will be to a
-     * fast local disk. Defaults to 10 seconds.
+     * fast local disk.
+     *
+     * @default 30000 (30 seconds)
      */
     taskTimeoutMillis: number;
     /**
      * An interval timer is scheduled to do periodic maintenance of underlying
      * child processes with this periodicity.
      *
-     * Defaults to 2 seconds.
+     * @default 2000 (2 seconds)
      */
     onIdleIntervalMillis: number;
     /**
      * The number of times a task can error or timeout and be retried.
      *
-     * Defaults to 1 (every task gets 2 chances).
+     * @default 1 (every task gets 2 chances)
      */
     taskRetries: number;
     /**
-     * Allows for non-standard paths to ExifTool. Defaults to the perl or
-     * windows binaries provided by `exiftool-vendored.pl` or
-     * `exiftool-vendored.exe`.
+     * Allows for non-standard paths to ExifTool.
      *
      * This must be the full path to `exiftool`, not just the directory.
+     *
+     * @default Path to vendored ExifTool binary
      */
     exiftoolPath: string | Promise<string> | ((logger?: bc.Logger) => string | Promise<string>);
     /**
      * Args only passed to exiftool on launch. You probably don't need to change
      * this from the default.
+     *
+     * @default `["-charset", "filename=utf8"]`
      */
     exiftoolArgs: string[];
     /**
      * Environment variables passed to ExifTool (besides `EXIFTOOL_HOME`)
+     *
+     * @default `{}`
      */
     exiftoolEnv: NodeJS.ProcessEnv;
     /**
      * Should ExifTool use MWG (Metadata Working Group) composite tags for
      * reading and writing tags?
      *
-     * ExifTool recommends this to be set to true.
-     *
-     * Note that this can result in many tag value differences from
-     * `ExifTool.read`, and makes `ExifTool.write` write to "synonymous" MWG
-     * tags automatically.
+     * ExifTool recommends this to be set to `true`. Note that this can result
+     * in many tag value differences from `ExifTool.read`, and makes
+     * `ExifTool.write` write to "synonymous" MWG tags automatically.
      *
+     * @default true
      * @see https://exiftool.org/TagNames/MWG.html for details
      */
     useMWG: boolean;
@@ -92,9 +97,7 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * If you're using tag values only for human consumption, you may want to
      * leave this blank.
      *
-     * The default includes "*Duration*", {@link Tags.GPSAltitude},
-     * {@link Tags.GPSLatitude}, {@link Tags.GPSLongitude},
-     * {@link Tags.GPSPosition}, and {@link Tags.Orientation}.
+     * @default `["*Duration*", "GPSAltitude", "GPSLatitude", "GPSLongitude", "GPSPosition", "GeolocationPosition", "Orientation"]`
      */
     numericTags: string[];
     /**
@@ -105,7 +108,7 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * MRW, RAF, X3F, IIQ, JP2, JXL, HEIC and AVIF images, MOV/MP4 videos, and
      * some RIFF-based files such as AVI, WAV and WEBP.
      *
-     * This defaults to undefined, as it adds ~20ms of overhead to every read
+     * @default false (disabled, as it adds ~20ms of overhead to every read)
      */
     imageHashType: false | "MD5" | "SHA256" | "SHA512";
     /**
@@ -114,8 +117,9 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
     includeImageDataMD5: boolean | undefined;
     /**
      * Video file dates are assumed to be in UTC, rather than using timezone
-     * inference used in images. To disable this default, set this to false.
+     * inference used in images. To disable this default, set this to `false`.
      *
+     * @default true
      * @see https://github.com/photostructure/exiftool-vendored.js/issues/113
      */
     defaultVideosToUTC: boolean;
@@ -127,11 +131,7 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * Setting this to `false` removes **all** timezone inference--only those
      * date-times with an explicit offset will have a defined timezone.
      *
-     * Prior versions of exiftool-vendored would use the file's `.tz` as a
-     * backstop even if this was set to `false`.
-     *
-     * As of version 23, this now defaults to `true`, as it's more likely to be
-     * what people expect.
+     * @default true
      */
     backfillTimezones: boolean;
     /**
@@ -143,8 +143,7 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * timezone from non-UTC datestamps included in the
      * {@link inferTimezoneFromDatestampTags} value.
      *
-     * This defaults to false as it both retains prior behavior and means fewer
-     * "fuzzy" heuristics are enabled by default.
+     * @default false (fewer "fuzzy" heuristics are enabled by default)
      */
     inferTimezoneFromDatestamps: boolean;
     /**
@@ -156,52 +155,52 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * This setting is only in play if {@link inferTimezoneFromDatestamps} has
      * been overridden to be `true`.
      *
-     * This defaults to {@link CapturedAtTagNames}
+     * @default {@link CapturedAtTagNames}
      */
     inferTimezoneFromDatestampTags: (keyof Tags)[];
     /**
      * Some cameras (Samsung Galaxy S7, for example) may not always include GPS
-     * metadata in photos if a fix can't be obtained. If this option is true, and
-     * GPS metadata is missing, we'll try to infer the timezone from the
+     * metadata in photos if a fix can't be obtained. If this option is `true`,
+     * and GPS metadata is missing, we'll try to infer the timezone from the
      * difference of the TimeStamp tag and the first defined tag value from
      * {@link inferTimezoneFromDatestampTags}.
      *
      * This heuristic is pretty sketchy, and used as a last resort. You shouldn't
      * enable it unless you have to.
      *
+     * @default false
      * @see https://github.com/photostructure/exiftool-vendored.js/issues/209
      */
     inferTimezoneFromTimeStamp: boolean;
     /**
      * Some software uses a GPS position of (0,0) as a synonym for "unset". If
-     * this option is true, and GPSLatitude and GPSLongitude are both 0, then
+     * this option is `true`, and GPSLatitude and GPSLongitude are both 0, then
      * those values will be returned, but the TZ will not be inferred from that
      * location.
      *
      * If both this and {@link geolocation} are `true`, we will _delete_ the
      * Geolocation tags from the returned metadata object.
      *
+     * @default true
      * @see https://en.wikipedia.org/wiki/Null_Island
      */
     ignoreZeroZeroLatLon: boolean;
     /**
      * Override the default geo-to-timezone lookup service. Note that if
-       {@link geolocation} is enabled, we'll use
-       {@link Tags.GeolocationTimeZone} if it's not blank.
-     *
-     * This defaults to `@photostructure/tz-lookup`, but if you have the
-     * resources, consider using `geo-tz` for more accurate results.
+     * {@link geolocation} is enabled, we'll use {@link Tags.GeolocationTimeZone}
+     * if it's not blank.
      *
-     * If your implementation throws an error, `ExifTool` will consider that given
-     * latitude/longitude as invalid.
+     * If your implementation throws an error, `ExifTool` will consider that
+     * given latitude/longitude as invalid.
      *
-     * Here's a snippet of how to use `geo-tz` instead of `tz-lookup`:
+     * @default `@photostructure/tz-lookup` (consider `geo-tz` for more accuracy)
      *
-  ```js
-  const geotz = require("geo-tz")
-  const { ExifTool } = require("exiftool-vendored")
-  const exiftool = new ExifTool({ geoTz: (lat, lon) => geotz.find(lat, lon)[0] })
-  ```
+     * @example
+     * ```js
+     * const geotz = require("geo-tz")
+     * const { ExifTool } = require("exiftool-vendored")
+     * const exiftool = new ExifTool({ geoTz: (lat, lon) => geotz.find(lat, lon)[0] })
+     * ```
      *
      * @see https://github.com/photostructure/tz-lookup
      * @see https://github.com/evansiroky/node-geo-tz/
@@ -211,6 +210,7 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * When reading metadata, should we enable ExifTool's geolocation features?
      * Note that this requires ExifTool version 12.78 or later.
      *
+     * @default false
      * @see https://exiftool.org/geolocation.html
      * @see {@link GeolocationTags}
      */
@@ -218,15 +218,15 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
     /**
      * Should we ignore minor errors when reading metadata?
      *
-     * This defaults to `true`, as ExifTool can be quite chatty.
+     * @default true (ExifTool can be quite chatty)
      */
     ignoreMinorErrors: boolean;
     /**
-     * When writing an extracted tag to a file,
-     * this will overwrite an existing file instead of throwing an error.
-     * Enabling this option is equivalent to `-w!` in ExifTool.
+     * When writing an extracted tag to a file, this will overwrite an existing
+     * file instead of throwing an error. Enabling this option is equivalent to
+     * `-w!` in ExifTool.
      *
-     * This defaults to `false`.
+     * @default false
      */
     forceWrite: boolean;
     /**
@@ -237,40 +237,46 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * Lambda), but `perl` may be available in your `PATH` some place else (like
      * `/opt/bin/perl`), if you pull in a perl layer.
      *
-     * This will default to `true` in those environments as a workaround in these
-     * situations. Note also that `perl` will be spawned in a sub-shell.
+     * Note that when enabled, `perl` will be spawned in a sub-shell.
+     *
+     * @default `true` on systems without `/usr/bin/perl`, `false` otherwise
      */
     ignoreShebang: boolean;
     /**
-     * Should we check for a readable and executable `perl` file in $PATH? This
-     * defaults to false on Windows, and true everywhere else. Set this to false
-     * if you know perl is installed.
+     * Should we check for a readable and executable `perl` file in $PATH? Set
+     * this to `false` if you know perl is installed.
+     *
+     * @default `false` on Windows, `true` elsewhere
      */
     checkPerl: boolean;
     /**
      * How should ExifTool handle nested structures?
      *
-     * Defaults to `1`.
-     *
-     * - `0` =  Read/copy flattened tags
-     * - `1` =  Read/copy structures
-     * - `2` =  Read/copy both flattened and structured tags, but flag flattened
+     * - `0` = Read/copy flattened tags
+     * - `1` = Read/copy structures
+     * - `2` = Read/copy both flattened and structured tags, but flag flattened
      *   tags as "unsafe" for copying
      * - `"undef"` = Same as `0` for reading and `2` for copying
      *
+     * @default 1
      * @see https://exiftool.org/struct.html
      */
     struct: "undef" | 0 | 1 | 2;
     /**
-     * Any additional arguments that should be added by default to all read tasks,
-     * like `["-fast", "-api", "largefilesupport=1"]`. The value provided to the
-     * ExifTool constructor can be overridden in the call to {@link ExifTool.read}
+     * Any additional arguments that should be added by default to all read
+     * tasks, like `["-fast", "-api", "largefilesupport=1"]`. The value provided
+     * to the ExifTool constructor can be overridden in the call to
+     * {@link ExifTool.read}.
+     *
+     * @default `["-fast"]`
      */
     readArgs: string[];
     /**
      * Any additional arguments that should be added by default to all write
      * tasks, like `["-overwrite_original"]`. The value provided to the ExifTool
      * constructor can be overridden in the call to {@link ExifTool.write}.
+     *
+     * @default `[]`
      */
     writeArgs: string[];
     /**
@@ -279,13 +285,13 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * Unfortunately, at least for some Nikon cameras, the TimeZone tag **and the
      * DaylightSavings tag** must be taken into account to find the UTC offset.
      *
-     * By default, this is a predicate that returns `true` if the `Make` tag is
-     * `Nikon`. If you find other makes and models that need this treatment,
-     * please open a ticket on GitHub with example images or videos and we can
-     * update the default predicate.
+     * If you find other makes and models that need this treatment, please open a
+     * ticket on GitHub with example images or videos and we can update the
+     * default predicate.
      *
      * The return value is the number of minutes to adjust the timezone by.
      *
+     * @default Returns 60 for Nikon cameras when `DaylightSavings` is `true`
      * @see https://github.com/photostructure/exiftool-vendored.js/issues/215
      */
     adjustTimeZoneIfDaylightSavings: (tags: Tags, tz: string) => Maybe<number>;
@@ -297,20 +303,20 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * values assigned to {@link TimezoneOffsetTagnames}.
      *
      * Note that there **are** regions that have had their IANA timezone change
-     * over time--this will result incorrect timezones.
+     * over time--this will result in incorrect timezones.
+     *
+     * @default false
      */
     preferTimezoneInferenceFromGps: boolean;
     /**
      * Should ExifTool keep times that are stored as seconds since UTC epoch as
-     * UTC times? If false, ExifTool will use local time instead of UTC/Zulu.
-     *
-     * We default to `true` to ensure we don't unintentionally adopt local
-     * timezones.
+     * UTC times? If `false`, ExifTool will use local time instead of UTC/Zulu.
      *
-     * Please note: when trying to validate this option, I **could not find a
-     * single example** that had a unixtime-encoded datetime, so I suspect this is
-     * irrelevant for most use cases and files.
+     * Note: when trying to validate this option, we could not find a single
+     * example that had a unixtime-encoded datetime, so this is likely irrelevant
+     * for most use cases and files.
      *
+     * @default true (to avoid unintentionally adopting local timezones)
      * @see https://exiftool.org/ExifTool.html#KeepUTCTime
      */
     keepUTCTime: boolean;
@@ -318,14 +324,14 @@ export interface ExifToolOptions extends bc.BatchClusterOptions, bc.BatchProcess
      * Timeout in milliseconds for synchronous disposal (using Symbol.dispose).
      * If graceful cleanup takes longer than this, forceful cleanup is attempted.
      *
-     * Defaults to 1000ms (1 second).
+     * @default 1000 (1 second)
      */
     disposalTimeoutMs?: number;
     /**
      * Timeout in milliseconds for asynchronous disposal (using Symbol.asyncDispose).
      * If graceful cleanup takes longer than this, forceful cleanup is attempted.
      *
-     * Defaults to 5000ms (5 seconds).
+     * @default 5000 (5 seconds)
      */
     asyncDisposalTimeoutMs?: number;
 }

package/dist/ExifToolOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExifToolOptions.js","sourceRoot":"","sources":["../src/ExifToolOptions.ts"],"names":[],"mappings":";;AAmXA,0DASC;AATD,SAAgB,uBAAuB,CAIrC,OAAU;IACV,IAAI,OAAO,CAAC,aAAa,IAAI,IAAI,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QACzE,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACtE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"ExifToolOptions.js","sourceRoot":"","sources":["../src/ExifToolOptions.ts"],"names":[],"mappings":";;AA0XA,0DASC;AATD,SAAgB,uBAAuB,CAIrC,OAAU;IACV,IAAI,OAAO,CAAC,aAAa,IAAI,IAAI,IAAI,OAAO,CAAC,mBAAmB,IAAI,IAAI,EAAE,CAAC;QACzE,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACtE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/File.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Checks if a file is empty or does not exist.
+ * @param path - the file path to check
+ * @returns true if the file is empty or does not exist, false otherwise
+ * @throws if path is blank or if a non-ENOENT error occurs
+ */
 export declare function isFileEmpty(path: string): Promise<boolean>;
+/**
+ * Returns true if the current platform has case-sensitive file paths.
+ */
 export declare const isPlatformCaseSensitive: import("./Lazy").Lazy<boolean>;
+/**
+ * Compares two file paths for equality, respecting platform case sensitivity.
+ * @param a - first file path
+ * @param b - second file path
+ * @returns true if paths refer to the same file
+ */
 export declare function compareFilePaths(a: string, b: string): boolean;

package/dist/File.js

@@ -3,24 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPlatformCaseSensitive = void 0;
 exports.isFileEmpty = isFileEmpty;
 exports.compareFilePaths = compareFilePaths;
-const node_fs_1 = require("node:fs");
+const promises_1 = require("node:fs/promises");
 const node_path_1 = require("node:path");
 const Lazy_1 = require("./Lazy");
 const String_1 = require("./String");
+/**
+ * Checks if a file is empty or does not exist.
+ * @param path - the file path to check
+ * @returns true if the file is empty or does not exist, false otherwise
+ * @throws if path is blank or if a non-ENOENT error occurs
+ */
 async function isFileEmpty(path) {
     if ((0, String_1.blank)(path)) {
         throw new Error("isFileEmpty(): blank path");
     }
-    // TODO: convert this to using fs/promises once node 12 is EOL (2022-04-30)
     try {
-        const s = await new Promise((res, rej) => {
-            try {
-                (0, node_fs_1.stat)(path, (err, val) => (err == null ? res(val) : rej(err)));
-            }
-            catch (err) {
-                rej(err);
-            }
-        });
+        const s = await (0, promises_1.stat)(path);
         return s == null || s.size === 0;
     }
     catch (err) {
@@ -33,7 +31,16 @@ async function isFileEmpty(path) {
             throw err;
     }
 }
+/**
+ * Returns true if the current platform has case-sensitive file paths.
+ */
 exports.isPlatformCaseSensitive = (0, Lazy_1.lazy)(() => process.platform !== "win32" && process.platform !== "darwin");
+/**
+ * Compares two file paths for equality, respecting platform case sensitivity.
+ * @param a - first file path
+ * @param b - second file path
+ * @returns true if paths refer to the same file
+ */
 function compareFilePaths(a, b) {
     const aNorm = (0, node_path_1.normalize)(a);
     const bNorm = (0, node_path_1.normalize)(b);

package/dist/File.js.map

@@ -1 +1 @@
-{"version":3,"file":"File.js","sourceRoot":"","sources":["../src/File.ts"],"names":[],"mappings":";;;AAKA,kCAyBC;AAMD,4CAMC;AA1CD,qCAAsC;AACtC,yCAAsC;AACtC,iCAA8B;AAC9B,qCAAiC;AAE1B,KAAK,UAAU,WAAW,CAAC,IAAY;IAC5C,IAAI,IAAA,cAAK,EAAC,IAAI,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,2EAA2E;IAC3E,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,MAAM,IAAI,OAAO,CAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC9C,IAAI,CAAC;gBACH,IAAA,cAAI,EAAC,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAChE,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,GAAG,CAAC,GAAG,CAAC,CAAC;YACX,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,IACE,GAAG;YACH,OAAO,GAAG,KAAK,QAAQ;YACvB,MAAM,IAAI,GAAG;YACb,GAAG,CAAC,IAAI,KAAK,QAAQ;YAErB,OAAO,IAAI,CAAC;;YACT,MAAM,GAAG,CAAC;IACjB,CAAC;AACH,CAAC;AAEY,QAAA,uBAAuB,GAAG,IAAA,WAAI,EACzC,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,CACpE,CAAC;AAEF,SAAgB,gBAAgB,CAAC,CAAS,EAAE,CAAS;IACnD,MAAM,KAAK,GAAG,IAAA,qBAAS,EAAC,CAAC,CAAC,CAAC;IAC3B,MAAM,KAAK,GAAG,IAAA,qBAAS,EAAC,CAAC,CAAC,CAAC;IAC3B,OAAO,IAAA,+BAAuB,GAAE;QAC9B,CAAC,CAAC,KAAK,KAAK,KAAK;QACjB,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC"}
+{"version":3,"file":"File.js","sourceRoot":"","sources":["../src/File.ts"],"names":[],"mappings":";;;AAWA,kCAkBC;AAeD,4CAMC;AAlDD,+CAAwC;AACxC,yCAAsC;AACtC,iCAA8B;AAC9B,qCAAiC;AAEjC;;;;;GAKG;AACI,KAAK,UAAU,WAAW,CAAC,IAAY;IAC5C,IAAI,IAAA,cAAK,EAAC,IAAI,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,MAAM,IAAA,eAAI,EAAC,IAAI,CAAC,CAAC;QAC3B,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,IACE,GAAG;YACH,OAAO,GAAG,KAAK,QAAQ;YACvB,MAAM,IAAI,GAAG;YACb,GAAG,CAAC,IAAI,KAAK,QAAQ;YAErB,OAAO,IAAI,CAAC;;YACT,MAAM,GAAG,CAAC;IACjB,CAAC;AACH,CAAC;AAED;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAA,WAAI,EACzC,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,CACpE,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,CAAS,EAAE,CAAS;IACnD,MAAM,KAAK,GAAG,IAAA,qBAAS,EAAC,CAAC,CAAC,CAAC;IAC3B,MAAM,KAAK,GAAG,IAAA,qBAAS,EAAC,CAAC,CAAC,CAAC;IAC3B,OAAO,IAAA,+BAAuB,GAAE;QAC9B,CAAC,CAAC,KAAK,KAAK,KAAK;QACjB,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC"}

package/dist/Object.d.ts

@@ -1,6 +1,27 @@
 import { Nullable } from "./Maybe";
+/**
+ * Type guard that checks if a value is a non-null, non-array object.
+ *
+ * @param obj - The value to check
+ * @returns `true` if `obj` is a plain object (not null, not an array)
+ */
 export declare function isObject(obj: unknown): obj is object;
+/**
+ * Returns an array of own enumerable string keys from an object.
+ *
+ * Unlike `Object.keys`, this filters to only own enumerable properties and
+ * returns an empty array for null/undefined inputs.
+ *
+ * @param o - The object to extract keys from
+ * @returns Array of own enumerable string keys, or empty array if `o` is nullish
+ */
 export declare function keys<T extends object, K extends string & keyof T>(o: T): K[];
+/**
+ * Type guard that checks if a value is a function.
+ *
+ * @param obj - The value to check
+ * @returns `true` if `obj` is a function
+ */
 export declare function isFunction(obj: unknown): obj is (...args: unknown[]) => unknown;
 /**
  * Turns an array of `[key, value]` pairs into an object.
@@ -9,9 +30,22 @@ export declare function isFunction(obj: unknown): obj is (...args: unknown[]) =>
  *  - If `base` is provided it is mutated and returned (handy for “extend” use‑cases).
  */
 export declare function fromEntries<K extends PropertyKey, V = unknown>(pairs: Nullable<Nullable<[Nullable<K>, V]>[]>, base?: Record<K, V>): Record<K, V>;
+/**
+ * Utility type that removes specified keys from a type by setting their values to `never`.
+ *
+ * @typeParam T - The source object type
+ * @typeParam U - The keys to exclude
+ */
 export type Unpick<T, U> = {
     [P in keyof T]: P extends U ? never : T[P];
 };
+/**
+ * Returns a shallow copy of an object with the specified keys omitted.
+ *
+ * @param t - The source object
+ * @param keysToOmit - Keys to exclude from the result
+ * @returns A new object without the specified keys
+ */
 export declare function omit<T extends object, S extends string>(t: T, ...keysToOmit: S[]): Unpick<T, S>;
 /**
  * Provides a type-safe exhaustive array of keys for a given interface.

package/dist/Object.js

@@ -6,14 +6,35 @@ exports.isFunction = isFunction;
 exports.fromEntries = fromEntries;
 exports.omit = omit;
 exports.keysOf = keysOf;
+/**
+ * Type guard that checks if a value is a non-null, non-array object.
+ *
+ * @param obj - The value to check
+ * @returns `true` if `obj` is a plain object (not null, not an array)
+ */
 function isObject(obj) {
-    return typeof obj === "object" && obj !== null;
+    return obj != null && typeof obj === "object" && !Array.isArray(obj);
 }
+/**
+ * Returns an array of own enumerable string keys from an object.
+ *
+ * Unlike `Object.keys`, this filters to only own enumerable properties and
+ * returns an empty array for null/undefined inputs.
+ *
+ * @param o - The object to extract keys from
+ * @returns Array of own enumerable string keys, or empty array if `o` is nullish
+ */
 function keys(o) {
     return o == null
         ? []
         : Object.keys(o).filter((ea) => ({}).propertyIsEnumerable.call(o, ea));
 }
+/**
+ * Type guard that checks if a value is a function.
+ *
+ * @param obj - The value to check
+ * @returns `true` if `obj` is a function
+ */
 function isFunction(obj) {
     return typeof obj === "function";
 }
@@ -34,6 +55,13 @@ function fromEntries(pairs, base = {}) {
     }
     return base;
 }
+/**
+ * Returns a shallow copy of an object with the specified keys omitted.
+ *
+ * @param t - The source object
+ * @param keysToOmit - Keys to exclude from the result
+ * @returns A new object without the specified keys
+ */
 function omit(t, ...keysToOmit) {
     const result = {};
     for (const k of keys(t).filter((ea) => !keysToOmit.includes(ea))) {

package/dist/Object.js.map

@@ -1 +1 @@
-{"version":3,"file":"Object.js","sourceRoot":"","sources":["../src/Object.ts"],"names":[],"mappings":";;AAEA,4BAEC;AAED,oBAMC;AAED,gCAIC;AAQD,kCAaC;AAID,oBAWC;AAWD,wBAEC;AAjED,SAAgB,QAAQ,CAAC,GAAY;IACnC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,CAAC;AACjD,CAAC;AAED,SAAgB,IAAI,CAA+C,CAAI;IACrE,OAAO,CAAC,IAAI,IAAI;QACd,CAAC,CAAC,EAAE;QACJ,CAAC,CAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC5B,CAAC,EAAE,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAC9B,CAAC;AAChB,CAAC;AAED,SAAgB,UAAU,CACxB,GAAY;IAEZ,OAAO,OAAO,GAAG,KAAK,UAAU,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CACzB,KAA6C,EAC7C,OAAqB,EAAkB;IAEvC,4DAA4D;IAC5D,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,IAAK,EAAmB,CAAC;IAE7E,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,CAAC,CAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAM,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAID,SAAgB,IAAI,CAClB,CAAI,EACJ,GAAG,UAAe;IAElB,MAAM,MAAM,GAAG,EAAO,CAAC;IACvB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAC5B,CAAC,EAAE,EAAE,EAAE,CAAC,CAAE,UAAuB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAChC,EAAE,CAAC;QACjB,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IACD,OAAO,MAAsB,CAAC;AAChC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,MAAM,CAAI,CAAkC;IAC1D,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAgB,CAAC;AACvC,CAAC;AAED,uDAAuD;AAEvD,yGAAyG"}
+{"version":3,"file":"Object.js","sourceRoot":"","sources":["../src/Object.ts"],"names":[],"mappings":";;AAOA,4BAEC;AAWD,oBAMC;AAQD,gCAIC;AAQD,kCAaC;AAiBD,oBAWC;AAWD,wBAEC;AAnGD;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,GAAY;IACnC,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACvE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,IAAI,CAA+C,CAAI;IACrE,OAAO,CAAC,IAAI,IAAI;QACd,CAAC,CAAC,EAAE;QACJ,CAAC,CAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC5B,CAAC,EAAE,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAC9B,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,GAAY;IAEZ,OAAO,OAAO,GAAG,KAAK,UAAU,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CACzB,KAA6C,EAC7C,OAAqB,EAAkB;IAEvC,4DAA4D;IAC5D,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,IAAK,EAAmB,CAAC;IAE7E,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,CAAC,CAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAM,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAUD;;;;;;GAMG;AACH,SAAgB,IAAI,CAClB,CAAI,EACJ,GAAG,UAAe;IAElB,MAAM,MAAM,GAAG,EAAO,CAAC;IACvB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAC5B,CAAC,EAAE,EAAE,EAAE,CAAC,CAAE,UAAuB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAChC,EAAE,CAAC;QACjB,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IACD,OAAO,MAAsB,CAAC;AAChC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,MAAM,CAAI,CAAkC;IAC1D,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAgB,CAAC;AACvC,CAAC;AAED,uDAAuD;AAEvD,yGAAyG"}

package/dist/ReadRawTask.js

@@ -73,7 +73,7 @@ class ReadRawTask extends ExifToolTask_1.ExifToolTask {
         this.args = args;
     }
     toString() {
-        return "ReadRawTask" + this.sourceFile + ")";
+        return "ReadRawTask(" + this.sourceFile + ")";
     }
     parse(data, err) {
         try {

package/dist/ReadRawTask.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReadRawTask.js","sourceRoot":"","sources":["../src/ReadRawTask.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAuC;AACvC,iDAAmC;AACnC,qEAAkE;AAClE,2DAAwD;AAExD,iDAA8C;AAC9C,+DAAgE;AAChE,iCAA8B;AAGjB,QAAA,uBAAuB,GAAG;IACrC,UAAU;IACV,mBAAmB;IACnB,QAAQ;CACoC,CAAC;AAElC,QAAA,yBAAyB,GAAG;IACvC,GAAG,IAAA,WAAI,EAAC,+CAAsB,EAAE,GAAG,+BAAuB,CAAC;CAChB,CAAC;AAI9C,MAAa,WAAY,SAAQ,2BAAqB;IAkBzC;IACS;IAlBpB,MAAM,CAAC,GAAG,CAAC,QAAgB,EAAE,OAA4B;QACvD,MAAM,IAAI,GAAa;YACrB,GAAG,6CAAuB;YAC1B,GAAG,CAAC,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC;SAC7B,CAAC;QACF,MAAM,IAAI,GAAG,EAAE,GAAG,iCAAyB,EAAE,GAAG,OAAO,EAAE,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtB,OAAO,IAAI,WAAW,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,YACW,UAAkB,EACT,IAAc,EAChC,OAAqC;QAErC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAJZ,eAAU,GAAV,UAAU,CAAQ;QACT,SAAI,GAAJ,IAAI,CAAU;IAIlC,CAAC;IAEQ,QAAQ;QACf,OAAO,aAAa,GAAG,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC/C,CAAC;IAES,KAAK,CAAC,IAAY,EAAE,GAAW;QACvC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,qCAAiB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC3D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,SAAS,EAAE,CAAC;YACnB,IAAA,sBAAM,GAAE,CAAC,KAAK,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YACjE,MAAM,GAAG,IAAI,SAAS,CAAC;QACzB,CAAC;IACH,CAAC;CACF;AAzCD,kCAyCC"}
+{"version":3,"file":"ReadRawTask.js","sourceRoot":"","sources":["../src/ReadRawTask.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAuC;AACvC,iDAAmC;AACnC,qEAAkE;AAClE,2DAAwD;AAExD,iDAA8C;AAC9C,+DAAgE;AAChE,iCAA8B;AAGjB,QAAA,uBAAuB,GAAG;IACrC,UAAU;IACV,mBAAmB;IACnB,QAAQ;CACoC,CAAC;AAElC,QAAA,yBAAyB,GAAG;IACvC,GAAG,IAAA,WAAI,EAAC,+CAAsB,EAAE,GAAG,+BAAuB,CAAC;CAChB,CAAC;AAI9C,MAAa,WAAY,SAAQ,2BAAqB;IAkBzC;IACS;IAlBpB,MAAM,CAAC,GAAG,CAAC,QAAgB,EAAE,OAA4B;QACvD,MAAM,IAAI,GAAa;YACrB,GAAG,6CAAuB;YAC1B,GAAG,CAAC,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC;SAC7B,CAAC;QACF,MAAM,IAAI,GAAG,EAAE,GAAG,iCAAyB,EAAE,GAAG,OAAO,EAAE,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtB,OAAO,IAAI,WAAW,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,YACW,UAAkB,EACT,IAAc,EAChC,OAAqC;QAErC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAJZ,eAAU,GAAV,UAAU,CAAQ;QACT,SAAI,GAAJ,IAAI,CAAU;IAIlC,CAAC;IAEQ,QAAQ;QACf,OAAO,cAAc,GAAG,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAChD,CAAC;IAES,KAAK,CAAC,IAAY,EAAE,GAAW;QACvC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,qCAAiB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC3D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,SAAS,EAAE,CAAC;YACnB,IAAA,sBAAM,GAAE,CAAC,KAAK,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YACjE,MAAM,GAAG,IAAI,SAAS,CAAC;QACzB,CAAC;IACH,CAAC;CACF;AAzCD,kCAyCC"}

package/dist/ReadTask.d.ts

@@ -34,6 +34,7 @@ export declare class ReadTask extends ExifToolTask<Tags> {
      * @param sourceFile the file to read
      * @param args the full arguments to pass to exiftool that take into account
      * the flags in `options`
+     * @param options the required options for reading metadata
      */
     constructor(sourceFile: string, args: string[], options: Required<ReadTaskOptions>);
     static for(filename: string, options: ReadTaskOptions): ReadTask;

package/dist/ReadTask.js

@@ -108,6 +108,7 @@ class ReadTask extends ExifToolTask_1.ExifToolTask {
      * @param sourceFile the file to read
      * @param args the full arguments to pass to exiftool that take into account
      * the flags in `options`
+     * @param options the required options for reading metadata
      */
     constructor(sourceFile, args, options) {
         super(args, options);
@@ -155,7 +156,7 @@ class ReadTask extends ExifToolTask_1.ExifToolTask {
         return new ReadTask(sourceFile, args, opts);
     }
     toString() {
-        return "ReadTask" + this.sourceFile + ")";
+        return "ReadTask(" + this.sourceFile + ")";
     }
     // only exposed for tests
     parse(data, err) {
@@ -317,12 +318,15 @@ class ReadTask extends ExifToolTask_1.ExifToolTask {
                 return value;
             }
             if (tagName.startsWith("GPS") || tagName.startsWith("Geolocation")) {
-                if (this.#gpsIsInvalid())
+                if (this.#gpsIsInvalid()) {
+                    // No GPS data should be trusted!
                     return undefined;
-                // If we parsed out a better value, use that:
-                const parsed = this.#gpsResults()[tagName];
-                if (parsed != null)
-                    return parsed;
+                }
+                const gpsResult = this.#gpsResults()?.[tagName];
+                if (gpsResult != null) {
+                    // If we parsed out a better value, use that:
+                    return gpsResult;
+                }
                 // Otherwise, parse the raw value like any other tag: (It might be
                 // something like "GPSTimeStamp"):
             }