Skip to content

Commit ac4294a

Browse files
committed
docs(README): update Tags interface documentation with JSDoc annotations and examples
1 parent 1178c32 commit ac4294a

1 file changed

Lines changed: 19 additions & 9 deletions

File tree

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -113,19 +113,29 @@ await exiftool.extractJpgFromRaw("photo.cr2", "processed.jpg");
113113
114114
## Understanding Tags
115115
116-
The `Tags` interface contains **thousands of metadata fields** from an auto-generated TypeScript file. Each tag uses a special notation:
116+
The `Tags` interface contains **thousands of metadata fields** from an auto-generated TypeScript file. Each tag includes semantic JSDoc annotations:
117117
118118
```typescript
119-
/** ★★★★ ✔ Example: 1920 */
120-
ImageWidth?: number; // Very common, all cameras
121-
122-
/** ★☆☆☆ Example: "Custom" */
123-
RareTag?: string; // Rare, <1% of files
119+
/**
120+
* @frequency 🔥 ★★★★ (85%)
121+
* @groups EXIF, MakerNotes
122+
* @example 100
123+
*/
124+
ISO?: number;
125+
126+
/**
127+
* @frequency 🧊 ★★★☆ (23%)
128+
* @groups MakerNotes
129+
* @example "Custom lens data"
130+
*/
131+
LensSpec?: string;
124132
```
125133
126-
- **★★★★** = Found in >50% of files (very common)
127-
- **★☆☆☆** = Very rare, <1% of files
128-
- **✔** = Found in popular cameras (Canon, Nikon, Sony, Apple)
134+
- **🔥** = Found on mainstream devices (iPhone, Canon, Nikon, Sony)
135+
- **🧊** = Found on more obscure camera makes and models
136+
- **★★★★** = Found in >50% of files, **☆☆☆☆** = rare (<1%)
137+
- **@groups** = Metadata categories (EXIF, GPS, IPTC, XMP, etc.)
138+
- **@example** = Representative values
129139
130140
**Important**: The interface isn't comprehensive - unknown fields may still exist in returned objects.
131141

0 commit comments

Comments
 (0)