Skip to content

Add types #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
non-bin wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add types #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions lib/mbox-reader.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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[]>;
}
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down