DefinitelyTyped/types/snekfetch/index.d.ts

// Type definitions for snekfetch 4.0
// Project: https://github.com/GusCaplan/snekfetch, https://snekfetch.js.org
// Definitions by: Iker Pérez Brunelli <https://github.com/ANekoIsFineToo>
//                 Shayne Hartford <https://github.com/ShayBox>
//                 Yukine <https://github.com/Dev-Yukine>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.4

/// <reference types="node" />

import { ClientRequest, Agent } from 'http';
import { Readable } from 'stream';

declare namespace Snekfetch {
    interface SnekfetchOptions {
        headers?: { [key: string]: any };
        data?: object | string | Buffer;
        agent?: Agent | boolean;
        qs?: object;
        query?: object | string;
        redirect?: boolean;
    }

    interface SnekfetchResponse {
        request: ClientRequest;
        body: string | object | Buffer;
        raw: Buffer;
        ok: boolean;
        headers: { [key: string]: any };
        status: number;
        statusText: string;
    }

    type methods = 'ACL'
        | 'BIND'
        | 'CHECKOUT'
        | 'CONNECT'
        | 'COPY'
        | 'DELETE'
        | 'GET'
        | 'HEAD'
        | 'LINK'
        | 'LOCK'
        | 'MERGE'
        | 'MKACTIVITY'
        | 'MKCALENDAR'
        | 'MKCOL'
        | 'MOVE'
        | 'NOTIFY'
        | 'OPTIONS'
        | 'PATCH'
        | 'POST'
        | 'PROPFIND'
        | 'PROPPATCH'
        | 'PURGE'
        | 'PUT'
        | 'REBIND'
        | 'REPORT'
        | 'SEARCH'
        | 'SOURCE'
        | 'SUBSCRIBE'
        | 'TRACE'
        | 'UNBIND'
        | 'UNLINK'
        | 'UNLOCK'
        | 'UNSUBSCRIBE';
}

declare class Snekfetch extends Readable {
    static METHODS: Snekfetch.methods[];
    static version: string;

    data: any;
    request: ClientRequest;
    readonly response: Snekfetch.SnekfetchResponse | null;

    constructor(method: Snekfetch.methods, url: string, opts?: Snekfetch.SnekfetchOptions);

    static acl(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static bind(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static checkout(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static connect(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static copy(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static delete(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static get(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static head(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static link(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static lock(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static merge(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static mkactivity(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static mkcalendar(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static mkcol(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static move(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static notify(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static options(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static patch(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static post(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static propfind(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static proppatch(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static purge(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static put(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static rebind(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static report(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static search(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static source(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static subscribe(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static trace(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static unbind(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static unlink(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static unlock(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;
    static unsubscribe(url: string, opts?: Snekfetch.SnekfetchOptions): Snekfetch;

    query(name: string | { [key: string]: any }, value?: string): Snekfetch;

    set(name: string | { [key: string]: any }, value?: string): Snekfetch;

    attach(name: string, data: string | object | Buffer, filename?: string): Snekfetch;

    send(data?: string | Buffer | object): Snekfetch;

    then(): Promise<Snekfetch.SnekfetchResponse>;
    then<T>(resolver: (res: Snekfetch.SnekfetchResponse) => T, rejector?: (err: Error) => any): Promise<T>;

    catch(rejector: (err: Error) => any): Promise<Snekfetch.SnekfetchResponse>;

    end(): Promise<Snekfetch.SnekfetchResponse>;
    end<T>(cb: (err: Error | null, res: Snekfetch.SnekfetchResponse | Error | null) => T): Promise<T>;
}

export = Snekfetch;