mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-02-09 02:12:51 +00:00
58 lines
2.5 KiB
TypeScript
58 lines
2.5 KiB
TypeScript
// Type definitions for bent 7.0
|
|
// Project: https://github.com/mikeal/bent#readme
|
|
// Definitions by: Ovyerus <https://github.com/Ovyerus>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.7
|
|
|
|
/// <reference types="node" />
|
|
|
|
import { PassThrough, Stream } from 'stream';
|
|
|
|
type HttpMethod = 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH' | 'HEAD' | 'OPTIONS' | 'CONNECT' | 'TRACE';
|
|
type StatusCode = number;
|
|
type BaseUrl = string;
|
|
interface Headers {
|
|
[key: string]: any;
|
|
}
|
|
|
|
// Type first
|
|
declare function bent(type: 'string', ...args: bent.Options[]): bent.RequestFunction<string>;
|
|
declare function bent(type: 'buffer', ...args: bent.Options[]): bent.RequestFunction<Buffer | ArrayBuffer>;
|
|
declare function bent(type: 'json', ...args: bent.Options[]): bent.RequestFunction<bent.Json>;
|
|
|
|
// Method or url first
|
|
declare function bent(baseUrl: string, type: 'string', ...args: bent.Options[]): bent.RequestFunction<string>;
|
|
declare function bent(
|
|
baseUrl: string,
|
|
type: 'buffer',
|
|
...args: bent.Options[]
|
|
): bent.RequestFunction<Buffer | ArrayBuffer>;
|
|
declare function bent(baseUrl: string, type: 'json', ...args: bent.Options[]): bent.RequestFunction<bent.Json>;
|
|
declare function bent(baseUrl: string, ...args: bent.Options[]): bent.RequestFunction<bent.ValidResponse>;
|
|
|
|
declare function bent(...args: bent.Options[]): bent.RequestFunction<bent.ValidResponse>;
|
|
|
|
// If we get some sort of custom nominal types, or regex literals, we might be able to simplify to something similar to
|
|
// declare function bent(...args: bent.Options[]): bent.RequestFunction<bent.BentResponse>;
|
|
// declare function bent(...args: (bent.Options | 'string')[]): bent.RequestFunction<string>;
|
|
// declare function bent(...args: (bent.Options | 'buffer')[]): bent.RequestFunction<Buffer | ArrayBuffer>;
|
|
// declare function bent(...args: (bent.Options | 'json')[]): bent.RequestFunction<Json>;
|
|
|
|
declare namespace bent {
|
|
type RequestFunction<T extends ValidResponse> = (url: string, body?: RequestBody, headers?: Headers) => Promise<T>;
|
|
type Options = HttpMethod | StatusCode | Headers | BaseUrl;
|
|
type RequestBody = string | Stream | Buffer | ArrayBuffer | Json;
|
|
type NodeResponse = PassThrough & {
|
|
statusCode: number;
|
|
statusMessage: string;
|
|
headers: Headers;
|
|
};
|
|
type FetchResponse = Response & { statusCode: number };
|
|
type BentResponse = NodeResponse | FetchResponse;
|
|
|
|
type Json = { [key: string]: any; [key: number]: any } | any[];
|
|
type ValidResponse = BentResponse | string | Buffer | ArrayBuffer | Json;
|
|
}
|
|
|
|
export = bent;
|