DefinitelyTyped/needle/needle.d.ts

// Type definitions for needle 0.7.8
// Project: https://github.com/tomas/needle
// Definitions by: San Chen <https://github.com/bigsan>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference path="../node/node.d.ts" />

declare module "needle" {
    import * as http from 'http';
    import * as Buffer from 'buffer';
    module Needle {        
        interface NeedleResponse extends http.IncomingMessage {
            body: any;
            raw: Buffer;
            bytes: number;
        }
        interface ReadableStream extends NodeJS.ReadableStream {
        }

        interface Callback {
            (error: Error, response: NeedleResponse, body: any): void;
        }

        interface RequestOptions {
            timeout?: number;
            follow?: number;
            follow_max?: number;
            multipart?: boolean;
            proxy?: string;
            agent?: string;
            headers?: Object;
            auth?: string; // auto | digest | basic (default)
            json?: boolean;

            // These properties are overwritten by those in the 'headers' field
            compressed?: boolean;
            cookies?: { [name: string]: any; };
            // Overwritten if present in the URI
            username?: string;
            password?: string;
        }

        interface ResponseOptions {
            decode?: boolean;
            parse?: boolean;
            output?: any;
        }

        interface TLSOptions {
            pfx?: any;
            key?: any;
            passphrase?: string;
            cert?: any;
            ca?: any;
            ciphers?: any;
            rejectUnauthorized?: boolean;
            secureProtocol?: any;
        }

        interface NeedleStatic {
            defaults(options?: any): void;

            head(url: string): ReadableStream;
            head(url: string, callback?: Callback): ReadableStream;
            head(url: string, options?: RequestOptions, callback?: Callback): ReadableStream;

            get(url: string): ReadableStream;
            get(url: string, callback?: Callback): ReadableStream;
            get(url: string, options?: RequestOptions, callback?: Callback): ReadableStream;

            post(url: string, data: any): ReadableStream;
            post(url: string, data: any, callback?: Callback): ReadableStream;
            post(url: string, data: any, options?: RequestOptions, callback?: Callback): ReadableStream;

            put(url: string, data: any): ReadableStream;
            put(url: string, data: any, callback?: Callback): ReadableStream;
            put(url: string, data: any, options?: RequestOptions, callback?: Callback): ReadableStream;

            delete(url: string, data: any): ReadableStream;
            delete(url: string, data: any, callback?: Callback): ReadableStream;
            delete(url: string, data: any, options?: RequestOptions, callback?: Callback): ReadableStream;

            request(method: string, url: string, data: any): ReadableStream;
            request(method: string, url: string, data: any, callback?: Callback): ReadableStream;
            request(method: string, url: string, data: any, options?: RequestOptions, callback?: Callback): ReadableStream;
        }
    }

    var needle: Needle.NeedleStatic;
    export = needle;
}