1 | import { Chain as LightMyRequestChain, InjectOptions, Response as LightMyRequestResponse, CallbackFunc as LightMyRequestCallback } from 'light-my-request'
|
2 | import { RouteOptions, RouteShorthandMethod, RouteGenericInterface } from './route'
|
3 | import { FastifySchemaCompiler } from './schema'
|
4 | import { RawServerBase, RawRequestDefaultExpression, RawServerDefault, RawReplyDefaultExpression, ContextConfigDefault } from './utils'
|
5 | import { FastifyLoggerInstance } from './logger'
|
6 | import { FastifyRegister } from './register'
|
7 | import { onRequestHookHandler, preParsingHookHandler, onSendHookHandler, preValidationHookHandler, preHandlerHookHandler, preSerializationHookHandler, onResponseHookHandler, onErrorHookHandler, onRouteHookHandler, onRegisterHookHandler, onCloseHookHandler, onReadyHookHandler } from './hooks'
|
8 | import { FastifyRequest } from './request'
|
9 | import { FastifyReply } from './reply'
|
10 | import { FastifyError } from 'fastify-error'
|
11 | import { AddContentTypeParser, hasContentTypeParser } from './content-type-parser'
|
12 |
|
13 |
|
14 |
|
15 |
|
16 | export interface FastifyInstance<
|
17 | RawServer extends RawServerBase = RawServerDefault,
|
18 | RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,
|
19 | RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>,
|
20 | Logger = FastifyLoggerInstance
|
21 | > {
|
22 | server: RawServer;
|
23 | prefix: string;
|
24 | log: Logger;
|
25 |
|
26 | addSchema(schema: unknown): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
27 |
|
28 | after(): FastifyInstance<RawServer, RawRequest, RawReply, Logger> & PromiseLike<undefined>;
|
29 | after(afterListener: (err: Error) => void): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
30 |
|
31 | close(): FastifyInstance<RawServer, RawRequest, RawReply, Logger> & PromiseLike<undefined>;
|
32 | close(closeListener: () => void): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
33 |
|
34 |
|
35 | decorate(property: string | symbol, value: any, dependencies?: string[]): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
36 | decorateRequest(property: string | symbol, value: any, dependencies?: string[]): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
37 | decorateReply(property: string | symbol, value: any, dependencies?: string[]): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
38 |
|
39 | hasDecorator(decorator: string | symbol): boolean;
|
40 | hasRequestDecorator(decorator: string | symbol): boolean;
|
41 | hasReplyDecorator(decorator: string | symbol): boolean;
|
42 |
|
43 | inject(opts: InjectOptions | string, cb: LightMyRequestCallback): void;
|
44 | inject(opts: InjectOptions | string): Promise<LightMyRequestResponse>;
|
45 | inject(): LightMyRequestChain;
|
46 |
|
47 | listen(port: number, address: string, backlog: number, callback: (err: Error, address: string) => void): void;
|
48 | listen(port: number, address: string, callback: (err: Error, address: string) => void): void;
|
49 | listen(port: number, callback: (err: Error, address: string) => void): void;
|
50 | listen(port: number, address?: string, backlog?: number): Promise<string>;
|
51 |
|
52 | ready(): FastifyInstance<RawServer, RawRequest, RawReply> & PromiseLike<undefined>;
|
53 | ready(readyListener: (err: Error) => void): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
54 |
|
55 | register: FastifyRegister<FastifyInstance<RawServer, RawRequest, RawReply, Logger> & PromiseLike<undefined>>;
|
56 |
|
57 | |
58 |
|
59 |
|
60 |
|
61 |
|
62 | use(...args: unknown[]): unknown;
|
63 |
|
64 | route<
|
65 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
66 | ContextConfig = ContextConfigDefault
|
67 | >(opts: RouteOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
68 |
|
69 | get: RouteShorthandMethod<RawServer, RawRequest, RawReply>;
|
70 | head: RouteShorthandMethod<RawServer, RawRequest, RawReply>;
|
71 | post: RouteShorthandMethod<RawServer, RawRequest, RawReply>;
|
72 | put: RouteShorthandMethod<RawServer, RawRequest, RawReply>;
|
73 | delete: RouteShorthandMethod<RawServer, RawRequest, RawReply>;
|
74 | options: RouteShorthandMethod<RawServer, RawRequest, RawReply>;
|
75 | patch: RouteShorthandMethod<RawServer, RawRequest, RawReply>;
|
76 | all: RouteShorthandMethod<RawServer, RawRequest, RawReply>;
|
77 |
|
78 |
|
79 |
|
80 |
|
81 |
|
82 | |
83 |
|
84 |
|
85 |
|
86 | addHook<
|
87 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
88 | ContextConfig = ContextConfigDefault
|
89 | >(
|
90 | name: 'onRequest',
|
91 | hook: onRequestHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
|
92 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
93 |
|
94 | |
95 |
|
96 |
|
97 |
|
98 | addHook<
|
99 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
100 | ContextConfig = ContextConfigDefault
|
101 | >(
|
102 | name: 'preParsing',
|
103 | hook: preParsingHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
|
104 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
105 |
|
106 | |
107 |
|
108 |
|
109 | addHook<
|
110 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
111 | ContextConfig = ContextConfigDefault
|
112 | >(
|
113 | name: 'preValidation',
|
114 | hook: preValidationHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
|
115 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
116 |
|
117 | |
118 |
|
119 |
|
120 | addHook<
|
121 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
122 | ContextConfig = ContextConfigDefault
|
123 | >(
|
124 | name: 'preHandler',
|
125 | hook: preHandlerHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
|
126 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
127 |
|
128 | |
129 |
|
130 |
|
131 |
|
132 | addHook<
|
133 | PreSerializationPayload = unknown,
|
134 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
135 | ContextConfig = ContextConfigDefault
|
136 | >(
|
137 | name: 'preSerialization',
|
138 | hook: preSerializationHookHandler<PreSerializationPayload, RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
|
139 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
140 |
|
141 | |
142 |
|
143 |
|
144 |
|
145 | addHook<
|
146 | OnSendPayload = unknown,
|
147 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
148 | ContextConfig = ContextConfigDefault
|
149 | >(
|
150 | name: 'onSend',
|
151 | hook: onSendHookHandler<OnSendPayload, RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
|
152 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
153 |
|
154 | |
155 |
|
156 |
|
157 |
|
158 | addHook<
|
159 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
160 | ContextConfig = ContextConfigDefault
|
161 | >(
|
162 | name: 'onResponse',
|
163 | hook: onResponseHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
|
164 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
165 |
|
166 | |
167 |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 | addHook<
|
173 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
174 | ContextConfig = ContextConfigDefault
|
175 | >(
|
176 | name: 'onError',
|
177 | hook: onErrorHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
|
178 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
179 |
|
180 |
|
181 |
|
182 | |
183 |
|
184 |
|
185 | addHook<
|
186 | RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
|
187 | ContextConfig = ContextConfigDefault
|
188 | >(
|
189 | name: 'onRoute',
|
190 | hook: onRouteHookHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
|
191 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
192 |
|
193 | |
194 |
|
195 |
|
196 |
|
197 |
|
198 | addHook(
|
199 | name: 'onRegister',
|
200 | hook: onRegisterHookHandler<RawServer, RawRequest, RawReply, Logger>
|
201 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
202 |
|
203 | |
204 |
|
205 |
|
206 | addHook(
|
207 | name: 'onReady',
|
208 | hook: onReadyHookHandler<RawServer, Logger>
|
209 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
210 |
|
211 | |
212 |
|
213 |
|
214 | addHook(
|
215 | name: 'onClose',
|
216 | hook: onCloseHookHandler<RawServer, RawRequest, RawReply, Logger>
|
217 | ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
218 |
|
219 | |
220 |
|
221 |
|
222 | setNotFoundHandler<RouteGeneric extends RouteGenericInterface = RouteGenericInterface>(
|
223 | handler: (request: FastifyRequest<RouteGeneric, RawServer, RawRequest>, reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric>) => void
|
224 | ): void;
|
225 |
|
226 | |
227 |
|
228 |
|
229 | setErrorHandler<TError extends Error = FastifyError, RouteGeneric extends RouteGenericInterface = RouteGenericInterface>(
|
230 | handler: (this: FastifyInstance<RawServer, RawRequest, RawReply, Logger>, error: TError, request: FastifyRequest<RouteGeneric, RawServer, RawRequest>, reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric>) => void
|
231 | ): void;
|
232 |
|
233 | |
234 |
|
235 |
|
236 | setValidatorCompiler(schemaCompiler: FastifySchemaCompiler): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
237 |
|
238 | |
239 |
|
240 |
|
241 | setSerializerCompiler(schemaCompiler: FastifySchemaCompiler): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
242 |
|
243 | |
244 |
|
245 |
|
246 | setReplySerializer(replySerializer: (payload: unknown, statusCode: number) => string): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
|
247 |
|
248 | |
249 |
|
250 |
|
251 | addContentTypeParser: AddContentTypeParser<RawServer, RawRequest>;
|
252 | hasContentTypeParser: hasContentTypeParser;
|
253 |
|
254 | |
255 |
|
256 |
|
257 | printRoutes(): string;
|
258 | }
|