From ad81ba62414caad94106ef2f215b2a4556246150 Mon Sep 17 00:00:00 2001
From: Julien Chaumond <chaumond@gmail.com>
Date: Wed, 10 Aug 2016 16:57:40 +0200
Subject: [PATCH] Add Typings

---
 epub.d.ts    | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 package.json |  1 +
 2 files changed, 67 insertions(+)
 create mode 100644 epub.d.ts

diff --git a/epub.d.ts b/epub.d.ts
new file mode 100644
index 0000000..7c813e0
--- /dev/null
+++ b/epub.d.ts
@@ -0,0 +1,66 @@
+// Type definitions for epub
+// Project: https://github.com/julien-c/epub
+// Definitions by: Julien Chaumond <https://github.com/julien-c>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+/**
+ *  new EPub(fname[, imageroot][, linkroot])
+ *  - fname (String): filename for the ebook
+ *  - imageroot (String): URL prefix for images
+ *  - linkroot (String): URL prefix for links
+ *
+ *  Creates an Event Emitter type object for parsing epub files
+ *
+ *      var epub = new EPub("book.epub");
+ *      epub.on("end", function () {
+ *           console.log(epub.spine);
+ *      });
+ *      epub.on("error", function (error) { ... });
+ *      epub.parse();
+ *
+ *  Image and link URL format is:
+ *
+ *      imageroot + img_id + img_zip_path
+ *
+ *  So an image "logo.jpg" which resides in "OPT/" in the zip archive
+ *  and is listed in the manifest with id "logo_img" will have the
+ *  following url (providing that imageroot is "/images/"):
+ *
+ *      /images/logo_img/OPT/logo.jpg
+ **/
+declare module "epub" {
+	
+	import {EventEmitter} from "events";
+	
+	interface TocElement {
+		level: number;
+		order: number;
+		title: string;
+		id: string;
+		href?: string;
+	}
+	
+	class EPub extends EventEmitter {
+		constructor(epubfile: string, imagewebroot?: string, chapterwebroot?: string);
+		
+		metadata: Object;
+		manifest: Object;
+		spine: Object;
+		flow: Array<Object>;
+		toc: Array<TocElement>;
+		
+		parse(): void;
+		
+		getChapter(chapterId: string, callback: (error: Error, text: string) => void): void;
+		
+		getChapterRaw(chapterId: string, callback: (error: Error, text: string) => void): void;
+		
+		getImage(id: string, callback: (error: Error, data: Buffer, mimeType: string) => void): void;
+		
+		getFile(id: string, callback: (error: Error, data: Buffer, mimeType: string) => void): void;
+	}
+	
+	export = EPub;
+}
diff --git a/package.json b/package.json
index cc3b773..bb92781 100644
--- a/package.json
+++ b/package.json
@@ -20,6 +20,7 @@
     "url": "http://github.com/julien-c/epub.git"
   },
   "main": "./epub",
+  "typings": "./epub.d.ts",
   "licenses": [
     {
       "type": "MIT",