From 66f33ff9e771190022a86bbdf7ab6752209e1c85 Mon Sep 17 00:00:00 2001
From: Alice Jacka <jacka.alice@gmail.com>
Date: Thu, 5 Jun 2025 11:59:32 +1000
Subject: [PATCH] Add types

---
 lib/mbox-reader.d.ts | 18 ++++++++++++++++++
 package.json         |  1 +
 2 files changed, 19 insertions(+)
 create mode 100644 lib/mbox-reader.d.ts

diff --git a/lib/mbox-reader.d.ts b/lib/mbox-reader.d.ts
new file mode 100644
index 0000000..601a4c1
--- /dev/null
+++ b/lib/mbox-reader.d.ts
@@ -0,0 +1,18 @@
+export module 'mbox-reader' {
+    /**
+     * gz: indicates if the input is a gz file (eg. gmail-takeout.mbox.gz). Default is false.
+     */
+    export function mboxReader(
+        sourceStream: ReadableStream,
+        options: { gz: boolean }
+    ): AsyncGenerator<mboxMessage>;
+}
+
+export interface mboxMessage {
+    returnPath: string;
+    time: Date | false;
+    content: Buffer;
+    flags: string[];
+    labels: string[];
+    headers: Map<string, string[]>;
+}
diff --git a/package.json b/package.json
index 7095576..ce5742c 100644
--- a/package.json
+++ b/package.json
@@ -3,6 +3,7 @@
     "version": "1.2.0",
     "description": "Read mbox file as a stream",
     "main": "lib/mbox-reader.js",
+    "typings": "lib/mbox-reader.d.ts",
     "scripts": {
         "test": "grunt",
         "update": "rm -rf node_modules package-lock.json && ncu -u && npm install"