@woss/exiftool - v0.3.1
    Preparing search index...

    Class ExifTool

    Node.js entry point for exiftool-ts. Extends ExifToolCore with filesystem-based read/write operations.

    This is the main class for Node.js environments. For browser/edge, use ExifToolCore directly with Uint8Array buffers.

    import { ExifTool } from 'exiftool-ts';

    const exiftool = new ExifTool();
    const result = await exiftool.read('photo.jpg');
    console.log(result.tags.Make, result.tags.Model);

    await exiftool.write('input.jpg', 'output.jpg', {
      Title: 'My Photo',
      Artist: 'John Doe',
    });

    Hierarchy (View Summary)

    Index
    constructor
    tagDb options
    getParser readBytes writeBytes read write run printHelp
    tagDb: TagDb

    Tag database for custom tag definitions.

    options: ExifToolOptions

    Resolved options (merged with defaults).

    • Parses metadata from an in-memory buffer.

      File-system-derived tags (FileName, FileSize, FileModifyDate, etc.) are absent — only embedded metadata is returned.

      Parameters

      • bytes: Uint8Array

        Image file data as Uint8Array

      Returns Promise<FileInfo>

      Parsed file information with tags

    • Writes metadata tags to an in-memory buffer.

      Returns the new bytes with updated metadata container (JPEG APP1, PNG eXIf, WebP EXIF, AVIF/HEIF meta box).

      Parameters

      • bytes: Uint8Array

        Original image data

      • tags: Record<string, TagValue>

        Tags to write (normalized format)

      Returns Promise<WriteOutcome>

      Write outcome with new bytes and any warnings

      UnsupportedFormatError if format doesn't support writing

    • Reads metadata from a file path.

      Parameters

      • filePath: string

        Path to the image file

      • Optionalhints: ParseHints

        Optional parsing hints for format-specific behavior

      Returns Promise<FileInfo>

      Parsed file information with tags grouped by metadata standard

    • Writes metadata tags to a file.

      Creates a backup file (<file>_original) unless overwriteOriginal is set. Supports JPEG (APP1), PNG (eXIf), WebP (EXIF), AVIF/HEIF (meta box).

      Parameters

      • filePath: string

        Path to the input file

      • tags: Record<string, TagValue>

        Tags to write (normalized format, see TagValue)

      • opts: { overwriteOriginal?: boolean } = {}

        Write options

        • OptionaloverwriteOriginal?: boolean

          Overwrite file without backup (default: false)

      Returns Promise<WriteResult>

      Write result with success status and any warnings

    • Runs CLI-style arguments programmatically.

      Parameters

      • args: string[]

        Command-line arguments (e.g., ['-j', 'photo.jpg'])

      Returns Promise<number>

      Exit code (0 = success)

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods