@types/fetch.io

Installation

npm install --save @types/fetch.io

Summary

This package contains type definitions for fetch.io (https://github.com/haoxins/fetch.io).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fetch.io.

index.d.ts

export type TUrl = string;

export type TMethod = "delete" | "get" | "head" | "options" | "post" | "put";

export interface Query {
    [key: string]: number | boolean | string;
}

export interface Header {
    [key: string]: string;
}

export interface Options extends RequestInit {
    prefix?: string | undefined;

    query?: Query | undefined;

    header?: Header | undefined;

    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    beforeRequest?(url: TUrl, body: BodyInit): boolean | void;

    afterResponse?(res: Response): void;

    afterJSON?(body: any): void;
}

export class Request {
    constructor(method: TMethod, url: TUrl, options: Options);

    /**
     * HTTP delete method
     */
    delete: (url: TUrl) => this;

    /**
     * HTTP get method
     */
    get: (url: TUrl) => this;

    /**
     * HTTP head method
     */
    head: (url: TUrl) => this;

    /**
     * HTTP options method
     */
    options: (url: TUrl) => this;

    /**
     * HTTP post method
     */
    post: (url: TUrl) => this;

    /**
     * HTTP put method
     */
    put: (url: TUrl) => this;

    /**
     * HTTP patch method
     */
    patch: (url: TUrl) => this;

    /**
     * Set Options
     */
    config(key: string, value: any): this;

    config(opts: { [key: string]: any }): this;

    /**
     * Set Header
     */
    set(key: string, value: any): this;

    set(opts: { [key: string]: any }): this;

    /**
     * Set Content-Type
     */
    type(type: "json" | "form" | "urlencoded"): this;

    /**
     * Add query string
     */
    query(object: { [key: string]: any }): this;

    /**
     * Send data
     */
    send(data: { [key: string]: any }): this;

    /**
     * append formData
     */
    append(key: string, value: any): this;

    append(object: { [key: string]: any }): this;

    /**
     * Get Response directly
     */
    then(resolve: (value?: Response) => void, reject?: (reason?: any) => void): Promise<any>;

    /**
     * Make Response to JSON
     */
    json(strict?: boolean): Promise<any>;

    /**
     * Make Response to string
     */
    text(): Promise<string>;
}

export default class Fetch extends Request {
    constructor(options?: Options);
}

Additional Details

• Last updated: Wed, 22 Nov 2023 00:24:48 GMT
• Dependencies: none

Credits

These definitions were written by newraina.