Update interfaces to follow whatwg-fetch spec changes

Not all spec options are followed by node-fetch, yet.
This commit is contained in:
Todd Lucas
2016-08-29 23:40:18 -07:00
parent affde8415d
commit 42bdaf0986
2 changed files with 95 additions and 31 deletions
@@ -1,4 +1,5 @@
/// <reference path="isomorphic-fetch.d.ts"/>
/// <reference path="../bluebird/bluebird-2.0.d.ts" />
import fetchImportedViaCommonJS = require('isomorphic-fetch');
import * as fetchImportedViaES6Module from 'isomorphic-fetch';
+94 -31
View File
@@ -3,48 +3,76 @@
// Definitions by: Todd Lucas <https://github.com/toddlucas>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
type RequestContext =
type RequestContext = // Deprecated
"audio" | "beacon" | "cspreport" | "download" | "embed" | "eventsource" |
"favicon" | "fetch" | "font" | "form" | "frame" | "hyperlink" | "iframe" |
"image" | "imageset" | "import" | "internal" | "location" | "manifest" |
"object" | "ping" | "plugin" | "prefetch" | "script" | "serviceworker" |
"sharedworker" | "subresource" | "style" | "track" | "video" | "worker" |
"xmlhttprequest" | "xslt";
type RequestMode = "same-origin" | "no-cors" | "cors";
type RequestType = "" | "audio" | "font" | "image" | "script" | "style" |
"track" | "video";
type RequestDestination = "" | "document" | "embed" | "font" | "image" |
"manifest" | "media" | "object" | "report" | "script" | "serviceworker" |
"sharedworker" | "style" | "worker" | "xslt";
type RequestMode = "navigate" | "same-origin" | "no-cors" | "cors";
type RequestCredentials = "omit" | "same-origin" | "include";
type RequestCache =
"default" | "no-store" | "reload" | "no-cache" | "force-cache" |
"only-if-cached";
type RequestRedirect = "follow" | "error" | "manual";
type ResponseType = "basic" | "cors" | "default" | "error" | "opaque";
type ResponseType = "basic" | "cors" | "default" | "error" | "opaque" |
"opaqueredirect";
declare type HeaderInit = Headers | Array<string>;
declare type BodyInit = ArrayBuffer | ArrayBufferView | Blob | FormData | string;
declare type RequestInfo = Request | string;
type HeadersInit = Headers | Array<string> | { [index: string]: string };
type BodyInit = Blob | ArrayBufferView | ArrayBuffer | FormData /* | URLSearchParams */ | string;
type ResponseBodyInit = BodyInit;
type ReferrerPolicy = "" | "no-referrer" | "no-referrer-when-downgrade" |
"same-origin" | "origin" | "strict-origin" | "origin-when-cross-origin" |
"strict-origin-when-cross-origin" | "unsafe-url";
interface RequestInit {
method?: string;
headers?: HeaderInit | { [index: string]: string };
headers?: HeadersInit;
body?: BodyInit;
referrer?: string;
referrerPolicy?: ReferrerPolicy;
mode?: RequestMode;
credentials?: RequestCredentials;
cache?: RequestCache;
redirect?: RequestRedirect;
integrity?: string;
window?: any; // can only be set to null
}
interface IHeaders {
get(name: string): string;
getAll(name: string): Array<string>;
has(name: string): boolean;
}
declare class Headers implements IHeaders {
append(name: string, value: string): void;
delete(name: string):void;
delete(name: string): void;
get(name: string): string;
getAll(name: string): Array<string>;
has(name: string): boolean;
set(name: string, value: string): void;
// TODO: iterable<string, string>;
forEach(callback: (value: string, index: number, headers: IHeaders) => void, thisArg?: any): void;
// NOTE: The following are supported by whatwg-fetch but not node-fetch.
// entries(): IterableIterator<[string, string]>;
// keys(): IterableIterator<string>;
// values(): IterableIterator<string>;
}
declare class Headers implements IHeaders {
constructor(init?: HeadersInit);
append(name: string, value: string): void;
delete(name: string): void;
get(name: string): string;
getAll(name: string): Array<string>;
has(name: string): boolean;
set(name: string, value: string): void;
forEach(callback: (value: string, index: number, headers: IHeaders) => void, thisArg?: any): void;
}
interface IBody {
@@ -70,49 +98,84 @@ declare class Body implements IBody {
interface IRequest extends IBody {
method: string;
url: string;
headers: Headers;
context: RequestContext;
referrer: string;
headers: IHeaders;
type: RequestType;
context: RequestContext; // Deprecated
destination: RequestDestination;
referrer?: string;
referrerPolicy?: ReferrerPolicy;
mode: RequestMode;
credentials: RequestCredentials;
cache: RequestCache;
redirect?: RequestRedirect;
integrity?: string;
clone(): IRequest;
}
type RequestInfo = IRequest | string;
declare class Request extends Body implements IRequest {
constructor(input: string | Request, init?: RequestInit);
constructor(input: RequestInfo, init?: RequestInit);
method: string;
url: string;
headers: Headers;
headers: IHeaders;
type: RequestType
context: RequestContext;
destination: RequestDestination;
referrer: string;
referrerPolicy: ReferrerPolicy;
mode: RequestMode;
credentials: RequestCredentials;
cache: RequestCache;
redirect: RequestRedirect;
integrity: string;
clone(): IRequest;
}
interface ResponseInit {
status?: number;
statusText?: string;
headers?: HeadersInit;
}
interface IResponse extends IBody {
type: ResponseType;
url: string;
redirected: boolean;
status: number;
statusText: string;
ok: boolean;
headers: IHeaders;
type: ResponseType;
size: number;
timeout: number;
redirect(url: string, status: number): IResponse;
// size: number;
// timeout: number;
body: any;
trailer: Promise<IHeaders>;
redirect(url: string, status?: number): IResponse;
error(): IResponse;
clone(): IResponse;
}
interface IFetchStatic {
Promise: any;
Headers: IHeaders
Request: IRequest;
Response: IResponse;
(url: string | IRequest, init?: RequestInit): Promise<IResponse>;
declare class Response extends Body implements IResponse {
constructor(body?: ResponseBodyInit, init?: ResponseInit);
type: ResponseType
url: string;
redirected: boolean;
status: number;
statusText: string;
ok: boolean;
headers: IHeaders;
body: any;
trailer: Promise<IHeaders>;
redirect(url: string, status?: number): IResponse;
error(): IResponse;
clone(): IResponse;
}
declare var fetch: IFetchStatic;
interface Window {
fetch(url: RequestInfo, init?: RequestInit): Promise<IResponse>;
}
declare var fetch: typeof window.fetch;
declare module "isomorphic-fetch" {
export = fetch;