Skip to content

Commit 6369a5c

Browse files
committed
fix(Docs): update links in TAGS.md to reflect the correct API documentation structure
1 parent 2224b35 commit 6369a5c

2 files changed

Lines changed: 26 additions & 32 deletions

File tree

CHANGELOG.md

Lines changed: 24 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ vendored versions of ExifTool match the version that they vendor.
8282
### v32.0.1
8383

8484
- 💔 Archaic timezones are no longer supported by default. If you have relevant (old) digital media, set `Settings.allowArchaicTimezoneOffsets.value = true`.
85-
- 💔 [useMWG](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifTool.ExifToolOptions.html#usemwg) now defaults to `true`, the ExifTool recommendation. See [the ExifTool page](https://exiftool.org/TagNames/MWG.html) for more details.
85+
- 💔 ExifToolOptions.useMWG now defaults to `true`, the ExifTool recommendation. See [the ExifTool page](https://exiftool.org/TagNames/MWG.html) for more details.
8686
- ✨ Added **Settings** for global library configuration. See [CONFIGURATION](https://photostructure.github.io/exiftool-vendored.js/documents/docs_CONFIGURATION.html) for details.
8787
- 📦 `MakerNotes.AspectRatio` was restored to the Tags union
8888
- 📦 `ExifTool.readRaw()` now accepts the option `useMWG` (which also defaults to `true`) and has a signature that matches `read()`.
@@ -204,9 +204,9 @@ vendored versions of ExifTool match the version that they vendor.
204204

205205
- 🌱 Upgraded ExifTool to version [13.25](https://exiftool.org/history.html#13.25).
206206

207-
-[ExifTool.write](https://photostructure.github.io/exiftool-vendored.js/classes/ExifTool.html#write) now supports `boolean` field values. Thanks for the [suggestion](https://github.com/photostructure/exiftool-vendored.js/issues/228), [Kira-Kitsune](https://github.com/Kira-Kitsune).
207+
- ✨ ExifTool.write() now supports `boolean` field values. Thanks for the [suggestion](https://github.com/photostructure/exiftool-vendored.js/issues/228), [Kira-Kitsune](https://github.com/Kira-Kitsune).
208208

209-
- 📦 Updated the default for [maxProcs](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifToolOptions.html#maxprocs) to use [availableParallelism](https://nodejs.org/api/os.html#osavailableparallelism) where available.
209+
- 📦 Updated the default for ExifToolOptions.maxProcs to use [availableParallelism](https://nodejs.org/api/os.html#osavailableparallelism) where available.
210210

211211
### v29.1.0
212212

@@ -333,7 +333,7 @@ vendored versions of ExifTool match the version that they vendor.
333333

334334
### v26.2.0
335335

336-
- ✨ Support for all ExifTool `struct` modes (fixes [#184](https://github.com/photostructure/exiftool-vendored.js/issues/184)). See [ExifToolOptions.struct](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifToolOptions.html#struct) for details.
336+
- ✨ Support for all ExifTool `struct` modes (fixes [#184](https://github.com/photostructure/exiftool-vendored.js/issues/184)). See ExifToolOptions.struct for details.
337337

338338
- 📦 Fix documentation to reference ExifTool.read() (fixes [#183](https://github.com/photostructure/exiftool-vendored.js/issues/183))
339339

@@ -347,7 +347,7 @@ vendored versions of ExifTool match the version that they vendor.
347347

348348
- 🌱/✨ ExifTool upgraded to [v12.84](https://exiftool.org/history.html#12.84)
349349

350-
- 📦 Support **disabling** `-ignoreMinorErrors` to work around shenanigans like [#181](https://github.com/photostructure/exiftool-vendored.js/issues/181). This is an optional field that defaults to prior behavior (enabled, which ignores minor errors, which is normally desired, _but has some side effects like fully reading tags that may be extremely long_). See [ExifToolOptions.ignoreMinorErrors](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifToolOptions.html#ignoreMinorErrors) for details.
350+
- 📦 Support **disabling** `-ignoreMinorErrors` to work around shenanigans like [#181](https://github.com/photostructure/exiftool-vendored.js/issues/181). This is an optional field that defaults to prior behavior (enabled, which ignores minor errors, which is normally desired, _but has some side effects like fully reading tags that may be extremely long_). See ExifToolOptions.ignoreMinorErrors for details.
351351

352352
- 📦 ExifTool on Windows was upgraded to Strawberry Perl 5.32.1
353353

@@ -362,7 +362,7 @@ vendored versions of ExifTool match the version that they vendor.
362362

363363
### v25.1.0
364364

365-
- ✨ Added `retain` field to [`ExifTool.deleteAllTags`](https://photostructure.github.io/exiftool-vendored.js/classes/ExifTool.html#deleteAllTags) to address [#178](https://github.com/photostructure/exiftool-vendored.js/issues/178)
365+
- ✨ Added `retain` field to ExifTool.deleteAllTags() to address [#178](https://github.com/photostructure/exiftool-vendored.js/issues/178)
366366

367367
- 📦 Added jsdocs for many `Tag` interface types
368368

@@ -378,15 +378,15 @@ vendored versions of ExifTool match the version that they vendor.
378378

379379
-`ExifToolOptions.exiftoolPath` can now be an `async` function
380380

381-
- ✨ Added [Geolocation](https://photostructure.github.io/exiftool-vendored.js/interfaces/GeolocationTags.html) Tags. These will only be available if `{geolocation: true}` is passed to the [ExifTool constructor](https://photostructure.github.io/exiftool-vendored.js/classes/ExifTool.html#constructor).
381+
- ✨ Added [Geolocation](https://exiftool.org/geolocation.html) Tags. These will only be available if ExifToolOptions.geolocation is set to true when constructing a new ExifTool instance.
382382

383-
- 📦 Added support for `electron-forge`: [see the docs for details](https://photostructure.github.io/exiftool-vendored.js/#md:electron-forge-support).
383+
- 📦 Added support for `electron-forge`: [see the docs for details](https://photostructure.github.io/exiftool-vendored.js/documents/docs_ELECTRON.html).
384384

385385
### v24.6.0
386386

387387
- 🌱 ExifTool upgraded to [v12.78](https://exiftool.org/history.html#v12.78)
388388

389-
- 📦 Added [ExifTool.off](https://photostructure.github.io/exiftool-vendored.js/classes/ExifTool.html#off)
389+
- 📦 Added ExifTool.off() for unregistering event listeners
390390

391391
### v24.5.0
392392

@@ -404,15 +404,15 @@ vendored versions of ExifTool match the version that they vendor.
404404

405405
- 🌱 ExifTool upgraded to [v12.72](https://exiftool.org/history.html#v12.72).
406406

407-
- 📦 Relax GPS latitude/longitude parser to handle invalid Ref values (a warning will be appended to the [Tags.warnings field](https://photostructure.github.io/exiftool-vendored.js/interfaces/Tags.html#warnings)). See [#165](https://github.com/photostructure/exiftool-vendored.js/issues/165).
407+
- 📦 Relax GPS latitude/longitude parser to handle invalid Ref values (a warning will be appended to the Tags.warnings field. See [#165](https://github.com/photostructure/exiftool-vendored.js/issues/165).
408408

409409
### v24.2.0
410410

411411
- 🐞 If `perl` isn't installed in `/usr/bin`, feed the full path to `perl` (if we can find it) to `spawn` (rather than relying on the shell to use `$PATH`). This should address issues like [#163](https://github.com/photostructure/exiftool-vendored.js/issues/163)
412412

413413
### v24.1.0
414414

415-
- 📦 Relaxed `isWarning()` detection to be simply `/warning:/i`. v24.0.0 would throw errors when extracting binary thumbnails due to issues like "Warning: Ignored non-standard EXIF at TIFF-IFD0-JPEG-APP1-IFD0", which is decidedly a warning. `ExifTool.write` now leans (hard) on returning [`Tags.warnings`](https://photostructure.github.io/exiftool-vendored.js/interfaces/Tags.html#warnings) rather than throwing errors: **It is up to you to inspect `.warnings` and decide for your own usecase if the issue is exceptional**. See [issue #162](https://github.com/photostructure/exiftool-vendored.js/issues/162) for details.
415+
- 📦 Relaxed `isWarning()` detection to be simply `/warning:/i`. v24.0.0 would throw errors when extracting binary thumbnails due to issues like "Warning: Ignored non-standard EXIF at TIFF-IFD0-JPEG-APP1-IFD0", which is decidedly a warning. `ExifTool.write` now leans (hard) on returning Tags.warnings rather than throwing errors: **It is up to you to inspect `.warnings` and decide for your own usecase if the issue is exceptional**. See [issue #162](https://github.com/photostructure/exiftool-vendored.js/issues/162) for details.
416416

417417
### v24.0.0
418418

@@ -475,15 +475,15 @@ vendored versions of ExifTool match the version that they vendor.
475475
### v23.2.0
476476

477477
- ✨ Timezone parsing improvements:
478-
- Added [`ExifToolOptions.inferTimezoneFromDatestampTags`](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifToolOptions.html#inferTimezoneFromDatestampTags).
478+
- Added inferTimezoneFromDatestampTags().
479479
- Timezone inference from datestamps now skips over UTC values, as Google
480480
Takeout (and several other applications) may spuriously set "+00:00" to
481481
datestamps.
482482
- ReadTask.parse in prior versions had to scan all tags twice to set the
483483
timezone. Code was refactored to do this in a single pass.
484484
- Timezone extraction and normalization was improved.
485485

486-
- 📦 Add `creationDate` to [CapturedAtTagNames](https://photostructure.github.io/exiftool-vendored.js/variables/CapturedAtTagNames.html). [See PR#159](https://github.com/photostructure/exiftool-vendored.js/pull/159).
486+
- 📦 Add `creationDate` to `CapturedAtTagNames`. [See PR#159](https://github.com/photostructure/exiftool-vendored.js/pull/159).
487487

488488
### v23.1.0
489489

@@ -547,9 +547,9 @@ vendored versions of ExifTool match the version that they vendor.
547547

548548
- 🌱 ExifTool upgraded to [v12.65](https://exiftool.org/history.html#v12.65)
549549

550-
- ✨ Add support for new `ImageDataHash` tag: [See the docs for details](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifToolOptions.html#imageHashType).
550+
- ✨ Add support for new `ImageDataHash` tag.
551551

552-
- 🐞 `perl` is checked for on non-windows machines at startup. This resolves [#152](https://github.com/photostructure/exiftool-vendored.js/issues/152). You can disable this with the [new `checkPerl` option](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifToolOptions.html#checkPerl).
552+
- 🐞 `perl` is checked for on non-windows machines at startup. This resolves [#152](https://github.com/photostructure/exiftool-vendored.js/issues/152). You can disable this with the new `checkPerl` ExifToolOption.
553553

554554
### v22.0.0
555555

@@ -567,9 +567,9 @@ vendored versions of ExifTool match the version that they vendor.
567567

568568
### v21.5.0
569569

570-
- ✨ Added support for ExifTool's [MWG Composite Tags](https://exiftool.org/TagNames/MWG.html). Set the new [`ExifToolOptions.useMWG`](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifToolOptions.html#useMWG) option to `true` to enable.
570+
- ✨ Added support for ExifTool's [MWG Composite Tags](https://exiftool.org/TagNames/MWG.html). Set the new ExifToolOptions.useMWG option to `true` to enable.
571571

572-
- ✨ Added support for ExifTool's new `ImageDataMD5` feature. Set the new [`ExifToolOptions.includeImageDataMD5`](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifToolOptions.html#includeImageDataMD5) option to `true` to enable.
572+
- ✨ Added support for ExifTool's new `ImageDataMD5` feature. Set the new ExifToolOptions.includeImageDataMD5 option to `true` to enable.
573573

574574
- 📦 Extracted options-related code into modules to remove a couple circular
575575
dependencies. Exports should make this transparent to external clients.
@@ -1277,8 +1277,8 @@ const exiftool = new ExifTool({
12771277

12781278
### v8.17.0
12791279

1280-
- ✨ Automagick workaround for AWS Lambda. See [the new `ignoreShebang`
1281-
option](https://photostructure.github.io/exiftool-vendored.js/interfaces/exiftooloptions.html#ignoreshebang),
1280+
- ✨ Automagick workaround for AWS Lambda. See the new `ExifToolOption.ignoreShebang`
1281+
option,
12821282
which should automatically be set to `true` on non-Windows platforms that
12831283
don't have `/usr/bin/perl` installed. [See
12841284
#53](https://github.com/photostructure/exiftool-vendored.js/issues/53).
@@ -1505,7 +1505,7 @@ most users won't be affected, unless you've been waiting for this feature!)
15051505
### v7.0.0: the "time zones & types are hard" edition
15061506

15071507
- ✨ More robust time zone extraction: this required adding `luxon` and
1508-
`tz-lookup` as dependencies. See <https://photostructure.github.io/exiftool-vendored.js/#dates> for
1508+
`tz-lookup` as dependencies. See <https://photostructure.github.io/exiftool-vendored.js/documents/docs_DATES.html> for
15091509
more information.
15101510

15111511
- 💔 Tag types are now **unions** of seen types. Previous typings only included
@@ -1571,16 +1571,14 @@ most users won't be affected, unless you've been waiting for this feature!)
15711571

15721572
- 🐞 Warnings work now, _and I even have a test to prove it_. 😳
15731573
- ✨ Warning-vs-fatal errors can be configured via the new
1574-
[`minorErrorsRegExp`](https://photostructure.github.io/exiftool-vendored.js/interfaces/exiftooloptions.html#minorerrorsregexp)
1574+
`minorErrorsRegExp`
15751575
constructor parameter, or if you need more flexibility, by providing a
1576-
[`rejectTaskOnStderr`](https://photostructure.github.io/exiftool-vendored.js/interfaces/exiftooloptions.html#rejecttaskonstderr)
1576+
`rejectTaskOnStderr`
15771577
implementation to the ExifTool constructor.
15781578

15791579
### v6.1.0
15801580

1581-
- ✨ Warnings are back! Non-fatal processing errors are added to the
1582-
[Tags.errors](https://photostructure.github.io/exiftool-vendored.js/interfaces/tags.html#errors)
1583-
field.
1581+
- ✨ Warnings are back! Non-fatal processing errors are added to the Tags.errors field.
15841582
- 📦 Pulled in new typedoc version and switched to "file" rendering, which seems
15851583
to generate better docs. This unfortunately broke links to underlying jsdocs.
15861584

@@ -1592,11 +1590,7 @@ most users won't be affected, unless you've been waiting for this feature!)
15921590

15931591
### v6.0.0
15941592

1595-
- 💔 `ExifTool`'s many constructor parameters turned out to be quite unwieldy.
1596-
Version 6's [constructor](https://photostructure.github.io/exiftool-vendored.js/classes/exiftool.html#constructor) now takes an [options
1597-
hash](https://photostructure.github.io/exiftool-vendored.js/interfaces/exiftooloptions.html).
1598-
If you used the defaults, those haven't changed, and your code won't need to
1599-
change.
1593+
- 💔 `ExifTool`'s many constructor parameters turned out to be quite unwieldy. Version 6's constructor now takes an options hash. If you used the defaults, those haven't changed, and your code won't need to change.
16001594
- 💔 `ExifTool.enqueueTask` takes a Task thunk now, to enable cleaner task retry
16011595
code. I don't expect many consumers will have used this API directly.
16021596
- 🐞 In prior versions, when maxTasksPerProcess was reached, on some OSes, the

docs/TAGS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ tags. // <-- IDE shows all available tags with descriptions
159159

160160
### 3. Check the Documentation
161161

162-
1. Visit the [online API docs](https://photostructure.github.io/exiftool-vendored.js/interfaces/Tags.html) to browse all available tags with examples.
162+
1. Visit the [online API docs](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifTool.Tags.html) to browse all available tags with examples.
163163

164164
2. Refer to the [excellent ExifTool documentation](https://exiftool.org/TagNames/index.html). Start with the [EXIF](https://exiftool.org/TagNames/EXIF.html), [IPTC](https://exiftool.org/TagNames/IPTC.html), and [XMP](https://exiftool.org/TagNames/XMP.html) groups -- those are the most common.
165165

@@ -215,7 +215,7 @@ const timestamp = tags.DateTimeOriginal ?? tags.DateTime ?? tags.FileModifyDate;
215215

216216
### Error Handling
217217

218-
Check for parsing [errors and warnings](https://photostructure.github.io/exiftool-vendored.js/interfaces/ErrorsAndWarnings.html) in the returned `Tags` object:
218+
Check for parsing [errors and warnings](https://photostructure.github.io/exiftool-vendored.js/interfaces/ExifTool.ErrorsAndWarnings.html) in the returned `Tags` object:
219219

220220
```typescript
221221
// const tags = await exiftool.read("photo.jpg");p

0 commit comments

Comments
 (0)