taglib-wasm 0.3.2 → 0.3.3

package/README.md

@@ -1,4 +1,7 @@
-# taglib-wasm
+# TagLib-Wasm
+
+> TagLib for TypeScript platforms: Deno, Node.js, Bun, browsers, and Cloudflare
+> Workers
 
 This is the Wasm version of [**TagLib**](https://taglib.org/), the most robust,
 de-facto standard for reading and editing metadata tags (Title, Album, Artist,
@@ -34,7 +37,7 @@ platform-specific dependencies whenever possible.
   TagLib
 - **✅ Format abstraction** – `taglib-wasm` deals with how tags are read
   from/written to in different file formats
-- **✅ Zero dependencies** – Self-contained WASM bundle
+- **✅ Zero dependencies** – Self-contained Wasm bundle
 - **✅ Memory efficient** – In-memory processing without filesystem access
 - **✅ Production ready** – Growing test suite helps ensure safety and
   reliability
@@ -163,18 +166,19 @@ const musicBrainzId = properties[Tags.MusicBrainzArtistId]?.[0];
 file.setProperties({
   [Tags.Title]: ["My Song"],
   [Tags.AlbumArtist]: ["Various Artists"],
-  [Tags.Bpm]: ["128"]
+  [Tags.Bpm]: ["128"],
 });
 
 // All constants provide IDE autocomplete
-Tags.Title         // → "TITLE"
-Tags.Artist        // → "ARTIST"
-Tags.AlbumArtist   // → "ALBUMARTIST"
-Tags.TrackGain     // → "REPLAYGAIN_TRACK_GAIN"
+Tags.Title; // → "TITLE"
+Tags.Artist; // → "ARTIST"
+Tags.AlbumArtist; // → "ALBUMARTIST"
+Tags.TrackGain; // → "REPLAYGAIN_TRACK_GAIN"
 // ... and many more
 ```
 
-See [Tag Name Constants](docs/Tag-Name-Constants.md) for the complete list of available tags and format-specific mappings.
+See [Tag Name Constants](docs/Tag-Name-Constants.md) for the complete list of
+available tags and format-specific mappings.
 
 ## Platform examples
 
@@ -404,7 +408,10 @@ and custom metadata.
 import { Tags } from "taglib-wasm";
 
 // Using PropertyMap API to set extended metadata with tag constants
-file.setProperty(Tags.AcoustidFingerprint, "AQADtMmybfGO8NCNEESLnzHyXNOHeHnG...");
+file.setProperty(
+  Tags.AcoustidFingerprint,
+  "AQADtMmybfGO8NCNEESLnzHyXNOHeHnG...",
+);
 file.setProperty(Tags.AcoustidId, "e7359e88-f1f7-41ed-b9f6-16e58e906997");
 
 // Or using string property names
@@ -419,8 +426,14 @@ file.save(); // Don't forget to save!
 
 ```typescript
 // MusicBrainz metadata using PropertyMap with tag constants
-file.setProperty(Tags.MusicBrainzTrackId, "f4d1b6b8-8c1e-4d9a-9f2a-1234567890ab");
-file.setProperty(Tags.MusicBrainzAlbumId, "a1b2c3d4-e5f6-7890-abcd-ef1234567890");
+file.setProperty(
+  Tags.MusicBrainzTrackId,
+  "f4d1b6b8-8c1e-4d9a-9f2a-1234567890ab",
+);
+file.setProperty(
+  Tags.MusicBrainzAlbumId,
+  "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+);
 file.setProperty(
   Tags.MusicBrainzArtistId,
   "12345678-90ab-cdef-1234-567890abcdef",
@@ -471,7 +484,7 @@ file.setProperty(Tags.Composer, "Composer Name");
 git clone <repository>
 cd taglib-wasm
 
-# Build WASM module
+# Build Wasm module
 deno task build:wasm
 
 # Run tests
@@ -485,7 +498,7 @@ src/
 ├── mod.ts          # Main module exports
 ├── taglib.ts       # Core TagLib and AudioFile classes
 ├── types.ts        # TypeScript type definitions
-└── wasm.ts         # WASM module interface and utilities
+└── wasm.ts         # Wasm module interface and utilities
 
 build/
 ├── build-wasm.sh   # Complete build script with C++ wrapper
@@ -526,11 +539,11 @@ npm test
 
 ### Key architecture decisions
 
-1. **Memory Management**: Uses Emscripten's `allocate()` for reliable JS↔WASM
+1. **Memory Management**: Uses Emscripten's `allocate()` for reliable JS↔Wasm
    data transfer
 2. **Buffer-Based Processing**: `TagLib::ByteVectorStream` enables in-memory
    file processing
-3. **C++ Wrapper**: Custom C functions bridge TagLib's C++ API to WASM exports
+3. **C++ Wrapper**: Custom C functions bridge TagLib's C++ API to Wasm exports
 4. **Type Safety**: Complete TypeScript definitions for all audio formats and
    metadata
 
@@ -541,7 +554,7 @@ npm test
 - **ID-based Object Management**: C++ objects managed via integer IDs for memory
   safety
 - **Emscripten allocate()**: Ensures proper memory synchronization between JS
-  and WASM
+  and Wasm
 - **UTF-8 String Handling**: Proper encoding for international metadata
 
 ## 📚 API Reference
@@ -621,10 +634,14 @@ type PropertyMap = { [key: string]: string[] };
 
 ## 📖 Additional Documentation
 
-- [**Tag Name Constants**](docs/Tag-Name-Constants.md) - Comprehensive reference for standard tag names and cross-format mapping
-- [**Automatic Tag Mapping**](docs/Automatic-Tag-Mapping.md) - How taglib-wasm handles format-specific tag differences
-- [**Implementation Details**](docs/Implementation.md) - Technical details about the Wasm implementation
-- [**Runtime Compatibility**](docs/Runtime-Compatibility.md) - Platform-specific setup and considerations
+- [**Tag Name Constants**](docs/Tag-Name-Constants.md) - Comprehensive reference
+  for standard tag names and cross-format mapping
+- [**Automatic Tag Mapping**](docs/Automatic-Tag-Mapping.md) - How taglib-wasm
+  handles format-specific tag differences
+- [**Implementation Details**](docs/Implementation.md) - Technical details about
+  the Wasm implementation
+- [**Runtime Compatibility**](docs/Runtime-Compatibility.md) - Platform-specific
+  setup and considerations
 
 ## 🌐 Runtime Compatibility