Add a typescript declaration file

README.md

@@ -28,6 +28,18 @@ request.get('/images/json', function(err, stream) {
 })
 ```
 
+### TypeScript
+
+Change `var` to `import` in order to tell typescript to use the declarations like so:
+
+``` ts
+import docker = require('docker-remote-api')
+var request = docker({
+  host: '/var/run/docker.sock'
+})
+```
+
+
 ## API
 
 #### `request = docker(options)`

package.json

@@ -3,6 +3,7 @@
   "description": "Basic http wrapper to call the docker remote api from node",
   "version": "5.0.0",
   "main": "index.js",
+  "types": "types.d.ts",
   "dependencies": {
     "concat-stream": "^1.4.6",
     "docker-host": "^3.0.0",

types.d.ts

@@ -0,0 +1,30 @@
+declare module 'docker-remote-api' {
+    interface InitOptions {
+        host: string;
+    }
+
+    interface GetOptions {
+        qs?: { [name: string]: string };      // set querystring parameters
+        headers?: { [name: string]: string }; // set request headers
+        json?: boolean;                      // return json instead of a stream
+        buffer?: boolean;                    // return a buffer instead of a stream
+        drain?: boolean;                     // will drain the response stream before calling cb
+        timeout?: number;                    // set request timeout
+        version: string;                     // set explicit api version "v1.14" (required)
+    }
+
+    interface PostOptions extends GetOptions {
+        body: string | null;   // set to NULL if there is no body json
+    }
+
+    class DockerRequest {
+        get<T>(path: string, opt: GetOptions, fn: (err: Error, data: T) => void): void;
+        delete<T>(path: string, opt: GetOptions, fn: (err: Error, data: T) => void): void;
+        head<T>(path: string, opt: GetOptions, fn: (err: Error, data: T) => void): void;
+        post<T>(path: string, opt: PostOptions, fn: (err: Error, data: T) => void): void;
+        put<T>(path: string, opt: PostOptions, fn: (err: Error, data: T) => void): void;
+    }
+
+    function DockerInit(opt: InitOptions): DockerRequest;
+    export = DockerInit;
+}