-
-
Notifications
You must be signed in to change notification settings - Fork 31
/
types.ts
114 lines (102 loc) · 4.27 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
import type { RequestListener } from 'http';
import type { NodeRequest, NodeResponse } from './utils.js';
import { UWSHandler, UWSRequest, UWSResponse } from './uwebsockets.js';
export interface FetchEvent extends Event {
waitUntil(f: Promise<void> | void): void;
request: Request;
respondWith(r: Response | PromiseLike<Response>): void;
}
export interface ServerAdapterBaseObject<
TServerContext,
THandleRequest extends
ServerAdapterRequestHandler<TServerContext> = ServerAdapterRequestHandler<TServerContext>,
> {
/**
* An async function that takes `Request` and the server context and returns a `Response`.
* If you use `requestListener`, the server context is `{ req: IncomingMessage, res: ServerResponse }`.
*/
handle: THandleRequest;
}
export interface ServerAdapterObject<TServerContext> extends EventListenerObject {
/**
* A basic request listener that takes a `Request` with the server context and returns a `Response`.
*/
handleRequest: (request: Request, ctx: TServerContext) => Promise<Response> | Response;
/**
* WHATWG Fetch spec compliant `fetch` function that can be used for testing purposes.
*/
fetch(request: Request, ctx: TServerContext): Promise<Response> | Response;
fetch(request: Request, ...ctx: Partial<TServerContext>[]): Promise<Response> | Response;
fetch(urlStr: string, ctx: TServerContext): Promise<Response> | Response;
fetch(urlStr: string, ...ctx: Partial<TServerContext>[]): Promise<Response> | Response;
fetch(urlStr: string, init: RequestInit, ctx: TServerContext): Promise<Response> | Response;
fetch(
urlStr: string,
init: RequestInit,
...ctx: Partial<TServerContext>[]
): Promise<Response> | Response;
fetch(url: URL, ctx: TServerContext): Promise<Response> | Response;
fetch(url: URL, ...ctx: Partial<TServerContext>[]): Promise<Response> | Response;
fetch(url: URL, init: RequestInit, ctx: TServerContext): Promise<Response> | Response;
fetch(
url: URL,
init: RequestInit,
...ctx: Partial<TServerContext>[]
): Promise<Response> | Response;
/**
* This function takes Node's request object and returns a WHATWG Fetch spec compliant `Response` object.
**/
handleNodeRequest(
nodeRequest: NodeRequest,
...ctx: Partial<TServerContext>[]
): Promise<Response> | Response;
/**
* This function takes Node's request and response objects and returns a WHATWG Fetch spec compliant `Response` object.
*/
handleNodeRequestAndResponse(
nodeRequest: NodeRequest,
nodeResponseOrContainer: { raw: NodeResponse } | NodeResponse,
...ctx: Partial<TServerContext>[]
): Promise<Response> | Response;
/**
* A request listener function that can be used with any Node server variation.
*/
requestListener: RequestListener;
handleUWS: UWSHandler;
handle(req: NodeRequest, res: NodeResponse, ...ctx: Partial<TServerContext>[]): Promise<void>;
handle(requestLike: RequestLike, ...ctx: Partial<TServerContext>[]): Promise<Response> | Response;
handle(request: Request, ...ctx: Partial<TServerContext>[]): Promise<Response> | Response;
handle(fetchEvent: FetchEvent & Partial<TServerContext>, ...ctx: Partial<TServerContext>[]): void;
handle(res: UWSResponse, req: UWSRequest, ...ctx: Partial<TServerContext>[]): Promise<void>;
handle(
container: { request: Request } & Partial<TServerContext>,
...ctx: Partial<TServerContext>[]
): Promise<Response> | Response;
}
export interface RequestLike {
url: string;
method: string;
headers: HeadersLike;
body?: AsyncIterable<Uint8Array> | null;
}
export interface HeadersLike extends Iterable<[string, string]> {
get(name: string): string | null | undefined;
set(name: string, value: string): void;
has(name: string): boolean;
}
export type ServerAdapter<
TServerContext,
TBaseObject extends ServerAdapterBaseObject<TServerContext>,
> = TBaseObject &
ServerAdapterObject<TServerContext>['handle'] &
ServerAdapterObject<TServerContext>;
export type ServerAdapterRequestHandler<TServerContext> = (
request: Request,
ctx: TServerContext,
) => Promise<Response> | Response;
export type ServerAdapterNodeContext = {
req: NodeRequest;
res: NodeResponse;
};
export type WaitUntilFn = (promise: Promise<void> | void) => void;
export type FetchAPI = ReturnType<typeof import('@whatwg-node/fetch').createFetch>;