-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
index.d.ts
189 lines (173 loc) · 4.3 KB
/
index.d.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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/// <reference types="svelte" />
/// <reference types="vite/client" />
import './ambient';
import { CompileOptions } from 'svelte/types/compiler/interfaces';
import {
Body,
Builder,
CspDirectives,
Either,
ErrorLoadInput,
Fallthrough,
LoadInput,
LoadOutput,
MaybePromise,
PrerenderOnErrorValue,
RequestEvent,
RequestOptions,
ResolveOptions,
ResponseHeaders,
TrailingSlash
} from './private';
import { SSRNodeLoader, SSRRoute } from './internal';
export interface Adapter {
name: string;
adapt(builder: Builder): Promise<void>;
}
export interface Config {
compilerOptions?: CompileOptions;
extensions?: string[];
kit?: {
adapter?: Adapter;
amp?: boolean;
appDir?: string;
browser?: {
hydrate?: boolean;
router?: boolean;
};
csp?: {
mode?: 'hash' | 'nonce' | 'auto';
directives?: CspDirectives;
};
endpointExtensions?: string[];
files?: {
assets?: string;
hooks?: string;
lib?: string;
routes?: string;
serviceWorker?: string;
template?: string;
};
floc?: boolean;
inlineStyleThreshold?: number;
methodOverride?: {
parameter?: string;
allowed?: string[];
};
outDir?: string;
package?: {
dir?: string;
emitTypes?: boolean;
exports?(filepath: string): boolean;
files?(filepath: string): boolean;
};
paths?: {
assets?: string;
base?: string;
};
prerender?: {
concurrency?: number;
crawl?: boolean;
default?: boolean;
enabled?: boolean;
entries?: string[];
onError?: PrerenderOnErrorValue;
};
routes?: (filepath: string) => boolean;
serviceWorker?: {
register?: boolean;
files?: (filepath: string) => boolean;
};
trailingSlash?: TrailingSlash;
version?: {
name?: string;
pollInterval?: number;
};
vite?: import('vite').UserConfig | (() => MaybePromise<import('vite').UserConfig>);
};
preprocess?: any;
}
export interface ErrorLoad<Params = Record<string, string>, Props = Record<string, any>> {
(input: ErrorLoadInput<Params>): MaybePromise<LoadOutput<Props>>;
}
export interface ExternalFetch {
(req: Request): Promise<Response>;
}
export interface GetSession {
(event: RequestEvent): MaybePromise<App.Session>;
}
export interface Handle {
(input: {
event: RequestEvent;
resolve(event: RequestEvent, opts?: ResolveOptions): MaybePromise<Response>;
}): MaybePromise<Response>;
}
export interface HandleError {
(input: { error: Error & { frame?: string }; event: RequestEvent }): void;
}
/**
* The type of a `load` function exported from `<script context="module">` in a page or layout.
*
* Note that you can use [generated types](/docs/types#generated-types) instead of manually specifying the Params generic argument.
*/
export interface Load<
Params extends Record<string, string> = Record<string, string>,
InputProps extends Record<string, any> = Record<string, any>,
OutputProps extends Record<string, any> = InputProps
> {
(input: LoadInput<Params, InputProps>): MaybePromise<
Either<Fallthrough, LoadOutput<OutputProps>>
>;
}
export interface Navigation {
from: URL;
to: URL;
}
export interface Page<Params extends Record<string, string> = Record<string, string>> {
url: URL;
params: Params;
stuff: App.Stuff;
status: number;
error: Error | null;
}
/**
* A function exported from an endpoint that corresponds to an
* HTTP verb (`get`, `put`, `patch`, etc) and handles requests with
* that method. Note that since 'delete' is a reserved word in
* JavaScript, delete handles are called `del` instead.
*
* Note that you can use [generated types](/docs/types#generated-types)
* instead of manually specifying the `Params` generic argument.
*/
export interface RequestHandler<Params = Record<string, string>, Output extends Body = Body> {
(event: RequestEvent<Params>): RequestHandlerOutput<Output>;
}
export type RequestHandlerOutput<Output extends Body = Body> = MaybePromise<
Either<
{
status?: number;
headers?: Headers | Partial<ResponseHeaders>;
body?: Output;
},
Fallthrough
>
>;
export class Server {
constructor(manifest: SSRManifest);
respond(request: Request, options?: RequestOptions): Promise<Response>;
}
export interface SSRManifest {
appDir: string;
assets: Set<string>;
/** private fields */
_: {
mime: Record<string, string>;
entry: {
file: string;
js: string[];
css: string[];
};
nodes: SSRNodeLoader[];
routes: SSRRoute[];
};
}