@forklaunch/hyper-express 0.5.4 → 0.5.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.mts +709 -24
- package/lib/index.d.ts +709 -24
- package/package.json +6 -5
package/lib/index.d.mts
CHANGED
|
@@ -1,13 +1,708 @@
|
|
|
1
|
-
import * as _forklaunch_hyper_express_fork from '@forklaunch/hyper-express-fork';
|
|
2
|
-
import { Server, MiddlewareHandler, Request, Response, MiddlewareNext, ServerConstructorOptions, Router as Router$1 } from '@forklaunch/hyper-express-fork';
|
|
3
|
-
export { MiddlewareNext as NextFunction, Request, Response } from '@forklaunch/hyper-express-fork';
|
|
4
1
|
import * as _forklaunch_core_http from '@forklaunch/core/http';
|
|
5
|
-
import { ForklaunchExpressLikeApplication, OpenTelemetryCollector, MetricsDefinition, DocsConfiguration, ForklaunchExpressLikeRouter, ForklaunchRouter, TypedMiddlewareDefinition } from '@forklaunch/core/http';
|
|
2
|
+
import { ParamsObject, ResponsesObject, Body, QueryObject, HeadersObject, ContractDetails, ExpressLikeSchemaHandler, ForklaunchExpressLikeApplication, OpenTelemetryCollector, MetricsDefinition, DocsConfiguration, ForklaunchExpressLikeRouter, ForklaunchRouter, TypedMiddlewareDefinition } from '@forklaunch/core/http';
|
|
3
|
+
import { Request, Response, MiddlewareNext, Server, MiddlewareHandler, ServerConstructorOptions, Router as Router$1 } from '@forklaunch/hyper-express-fork';
|
|
4
|
+
export { MiddlewareNext as NextFunction, Request, Response } from '@forklaunch/hyper-express-fork';
|
|
6
5
|
import { AnySchemaValidator } from '@forklaunch/validator';
|
|
7
6
|
import { BusboyConfig } from 'busboy';
|
|
8
7
|
import * as uWebsockets from 'uWebSockets.js';
|
|
9
8
|
export { ParsedQs } from 'qs';
|
|
10
9
|
|
|
10
|
+
/**
|
|
11
|
+
* Creates a route handler that matches any HTTP method with schema validation and type safety.
|
|
12
|
+
*
|
|
13
|
+
* @template SV - The schema validator type
|
|
14
|
+
* @template Path - The route path type (must start with '/')
|
|
15
|
+
* @template P - The path parameters type
|
|
16
|
+
* @template ResBodyMap - The response body map type
|
|
17
|
+
* @template ReqBody - The request body type
|
|
18
|
+
* @template ReqQuery - The request query parameters type
|
|
19
|
+
* @template ReqHeaders - The request headers type
|
|
20
|
+
* @template ResHeaders - The response headers type
|
|
21
|
+
* @template LocalsObj - The locals object type
|
|
22
|
+
*
|
|
23
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
24
|
+
* @param {Path} path - The route path
|
|
25
|
+
* @param {ContractDetails<SV, 'any', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
26
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
27
|
+
*
|
|
28
|
+
* @returns {void} - Returns nothing, registers the route with Hyper-Express
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```typescript
|
|
32
|
+
* any(
|
|
33
|
+
* schemaValidator,
|
|
34
|
+
* '/webhooks',
|
|
35
|
+
* {
|
|
36
|
+
* summary: 'Webhook endpoint',
|
|
37
|
+
* description: 'Handles webhook requests from any HTTP method',
|
|
38
|
+
* tags: ['webhooks'],
|
|
39
|
+
* responses: {
|
|
40
|
+
* 200: {
|
|
41
|
+
* description: 'Webhook processed successfully',
|
|
42
|
+
* content: {
|
|
43
|
+
* 'application/json': {
|
|
44
|
+
* schema: {
|
|
45
|
+
* type: 'object',
|
|
46
|
+
* properties: {
|
|
47
|
+
* status: { type: 'string' }
|
|
48
|
+
* }
|
|
49
|
+
* }
|
|
50
|
+
* }
|
|
51
|
+
* }
|
|
52
|
+
* }
|
|
53
|
+
* }
|
|
54
|
+
* },
|
|
55
|
+
* async (req, res) => {
|
|
56
|
+
* const method = req.method;
|
|
57
|
+
* const body = await req.json();
|
|
58
|
+
* await processWebhook(method, body);
|
|
59
|
+
* res.status(200).json({ status: 'processed' });
|
|
60
|
+
* }
|
|
61
|
+
* );
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
declare const any: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "middleware", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => {
|
|
65
|
+
_typedHandler: true;
|
|
66
|
+
_path: Path;
|
|
67
|
+
contractDetails: _forklaunch_core_http.MiddlewareContractDetails<SV, Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>;
|
|
68
|
+
handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[];
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Creates a DELETE route handler with schema validation and type safety.
|
|
73
|
+
*
|
|
74
|
+
* @template SV - The schema validator type
|
|
75
|
+
* @template Path - The route path type (must start with '/')
|
|
76
|
+
* @template P - The path parameters type
|
|
77
|
+
* @template ResBodyMap - The response body map type
|
|
78
|
+
* @template ReqBody - The request body type
|
|
79
|
+
* @template ReqQuery - The request query parameters type
|
|
80
|
+
* @template ReqHeaders - The request headers type
|
|
81
|
+
* @template ResHeaders - The response headers type
|
|
82
|
+
* @template LocalsObj - The locals object type
|
|
83
|
+
*
|
|
84
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
85
|
+
* @param {Path} path - The route path
|
|
86
|
+
* @param {ContractDetails<SV, 'delete', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
87
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
88
|
+
*
|
|
89
|
+
* @returns {void} - Returns nothing, registers the route with Hyper-Express
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```typescript
|
|
93
|
+
* delete_(
|
|
94
|
+
* schemaValidator,
|
|
95
|
+
* '/users/:id',
|
|
96
|
+
* {
|
|
97
|
+
* summary: 'Delete user',
|
|
98
|
+
* description: 'Deletes a user by ID',
|
|
99
|
+
* tags: ['users'],
|
|
100
|
+
* parameters: [
|
|
101
|
+
* {
|
|
102
|
+
* name: 'id',
|
|
103
|
+
* in: 'path',
|
|
104
|
+
* required: true,
|
|
105
|
+
* schema: { type: 'string' }
|
|
106
|
+
* }
|
|
107
|
+
* ],
|
|
108
|
+
* responses: {
|
|
109
|
+
* 204: {
|
|
110
|
+
* description: 'User deleted successfully'
|
|
111
|
+
* },
|
|
112
|
+
* 404: {
|
|
113
|
+
* description: 'User not found',
|
|
114
|
+
* content: {
|
|
115
|
+
* 'application/json': {
|
|
116
|
+
* schema: {
|
|
117
|
+
* type: 'object',
|
|
118
|
+
* properties: {
|
|
119
|
+
* error: { type: 'string' }
|
|
120
|
+
* }
|
|
121
|
+
* }
|
|
122
|
+
* }
|
|
123
|
+
* }
|
|
124
|
+
* }
|
|
125
|
+
* }
|
|
126
|
+
* },
|
|
127
|
+
* async (req, res) => {
|
|
128
|
+
* const { id } = req.params;
|
|
129
|
+
* await deleteUser(id);
|
|
130
|
+
* res.status(204).end();
|
|
131
|
+
* }
|
|
132
|
+
* );
|
|
133
|
+
* ```
|
|
134
|
+
*/
|
|
135
|
+
declare const delete_: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "delete", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "delete", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Creates a GET route handler with schema validation and type safety.
|
|
139
|
+
*
|
|
140
|
+
* @template SV - The schema validator type
|
|
141
|
+
* @template Path - The route path type (must start with '/')
|
|
142
|
+
* @template P - The path parameters type
|
|
143
|
+
* @template ResBodyMap - The response body map type
|
|
144
|
+
* @template ReqBody - The request body type
|
|
145
|
+
* @template ReqQuery - The request query parameters type
|
|
146
|
+
* @template ReqHeaders - The request headers type
|
|
147
|
+
* @template ResHeaders - The response headers type
|
|
148
|
+
* @template LocalsObj - The locals object type
|
|
149
|
+
*
|
|
150
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
151
|
+
* @param {Path} path - The route path
|
|
152
|
+
* @param {ContractDetails<SV, 'get', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
153
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
154
|
+
*
|
|
155
|
+
* @returns {void} - Returns nothing, registers the route with Hyper-Express
|
|
156
|
+
*
|
|
157
|
+
* @example
|
|
158
|
+
* ```typescript
|
|
159
|
+
* get(
|
|
160
|
+
* schemaValidator,
|
|
161
|
+
* '/users/:id',
|
|
162
|
+
* {
|
|
163
|
+
* summary: 'Get user',
|
|
164
|
+
* description: 'Retrieves a user by ID',
|
|
165
|
+
* tags: ['users'],
|
|
166
|
+
* parameters: [
|
|
167
|
+
* {
|
|
168
|
+
* name: 'id',
|
|
169
|
+
* in: 'path',
|
|
170
|
+
* required: true,
|
|
171
|
+
* schema: { type: 'string' }
|
|
172
|
+
* }
|
|
173
|
+
* ],
|
|
174
|
+
* responses: {
|
|
175
|
+
* 200: {
|
|
176
|
+
* description: 'User retrieved successfully',
|
|
177
|
+
* content: {
|
|
178
|
+
* 'application/json': {
|
|
179
|
+
* schema: {
|
|
180
|
+
* type: 'object',
|
|
181
|
+
* properties: {
|
|
182
|
+
* id: { type: 'string' },
|
|
183
|
+
* name: { type: 'string' },
|
|
184
|
+
* email: { type: 'string' }
|
|
185
|
+
* }
|
|
186
|
+
* }
|
|
187
|
+
* }
|
|
188
|
+
* }
|
|
189
|
+
* },
|
|
190
|
+
* 404: {
|
|
191
|
+
* description: 'User not found',
|
|
192
|
+
* content: {
|
|
193
|
+
* 'application/json': {
|
|
194
|
+
* schema: {
|
|
195
|
+
* type: 'object',
|
|
196
|
+
* properties: {
|
|
197
|
+
* error: { type: 'string' }
|
|
198
|
+
* }
|
|
199
|
+
* }
|
|
200
|
+
* }
|
|
201
|
+
* }
|
|
202
|
+
* }
|
|
203
|
+
* }
|
|
204
|
+
* },
|
|
205
|
+
* async (req, res) => {
|
|
206
|
+
* const { id } = req.params;
|
|
207
|
+
* const user = await getUser(id);
|
|
208
|
+
* res.status(200).json(user);
|
|
209
|
+
* }
|
|
210
|
+
* );
|
|
211
|
+
* ```
|
|
212
|
+
*/
|
|
213
|
+
declare const get: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "get", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "get", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* Creates a HEAD route handler with schema validation and type safety.
|
|
217
|
+
*
|
|
218
|
+
* @template SV - The schema validator type
|
|
219
|
+
* @template Path - The route path type (must start with '/')
|
|
220
|
+
* @template P - The path parameters type
|
|
221
|
+
* @template ResBodyMap - The response body map type
|
|
222
|
+
* @template ReqBody - The request body type
|
|
223
|
+
* @template ReqQuery - The request query parameters type
|
|
224
|
+
* @template ReqHeaders - The request headers type
|
|
225
|
+
* @template ResHeaders - The response headers type
|
|
226
|
+
* @template LocalsObj - The locals object type
|
|
227
|
+
*
|
|
228
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
229
|
+
* @param {Path} path - The route path
|
|
230
|
+
* @param {ContractDetails<SV, 'head', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
231
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
232
|
+
*
|
|
233
|
+
* @returns {void} - Returns nothing, registers the route with Hyper-Express
|
|
234
|
+
*
|
|
235
|
+
* @example
|
|
236
|
+
* ```typescript
|
|
237
|
+
* head(
|
|
238
|
+
* schemaValidator,
|
|
239
|
+
* '/files/:id',
|
|
240
|
+
* {
|
|
241
|
+
* summary: 'Get file metadata',
|
|
242
|
+
* description: 'Retrieves metadata for a file without downloading its contents',
|
|
243
|
+
* tags: ['files'],
|
|
244
|
+
* parameters: [
|
|
245
|
+
* {
|
|
246
|
+
* name: 'id',
|
|
247
|
+
* in: 'path',
|
|
248
|
+
* required: true,
|
|
249
|
+
* schema: { type: 'string' }
|
|
250
|
+
* }
|
|
251
|
+
* ],
|
|
252
|
+
* responses: {
|
|
253
|
+
* 200: {
|
|
254
|
+
* description: 'File metadata retrieved successfully',
|
|
255
|
+
* headers: {
|
|
256
|
+
* 'content-length': {
|
|
257
|
+
* schema: { type: 'string' }
|
|
258
|
+
* },
|
|
259
|
+
* 'content-type': {
|
|
260
|
+
* schema: { type: 'string' }
|
|
261
|
+
* },
|
|
262
|
+
* 'last-modified': {
|
|
263
|
+
* schema: { type: 'string' }
|
|
264
|
+
* }
|
|
265
|
+
* }
|
|
266
|
+
* },
|
|
267
|
+
* 404: {
|
|
268
|
+
* description: 'File not found'
|
|
269
|
+
* }
|
|
270
|
+
* }
|
|
271
|
+
* },
|
|
272
|
+
* async (req, res) => {
|
|
273
|
+
* const { id } = req.params;
|
|
274
|
+
* const metadata = await getFileMetadata(id);
|
|
275
|
+
* res.setHeader('content-length', metadata.size);
|
|
276
|
+
* res.setHeader('content-type', metadata.type);
|
|
277
|
+
* res.setHeader('last-modified', metadata.lastModified);
|
|
278
|
+
* res.status(200).end();
|
|
279
|
+
* }
|
|
280
|
+
* );
|
|
281
|
+
* ```
|
|
282
|
+
*/
|
|
283
|
+
declare const head: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "head", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "head", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* Creates a middleware handler with schema validation and type safety.
|
|
287
|
+
*
|
|
288
|
+
* @template SV - The schema validator type
|
|
289
|
+
* @template Path - The route path type (must start with '/')
|
|
290
|
+
* @template P - The path parameters type
|
|
291
|
+
* @template ResBodyMap - The response body map type
|
|
292
|
+
* @template ReqBody - The request body type
|
|
293
|
+
* @template ReqQuery - The request query parameters type
|
|
294
|
+
* @template ReqHeaders - The request headers type
|
|
295
|
+
* @template ResHeaders - The response headers type
|
|
296
|
+
* @template LocalsObj - The locals object type
|
|
297
|
+
*
|
|
298
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
299
|
+
* @param {Path} path - The route path
|
|
300
|
+
* @param {ContractDetails<SV, 'middleware', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
301
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
302
|
+
*
|
|
303
|
+
* @returns {void} - Returns nothing, registers the middleware with Hyper-Express
|
|
304
|
+
*
|
|
305
|
+
* @example
|
|
306
|
+
* ```typescript
|
|
307
|
+
* middleware(
|
|
308
|
+
* schemaValidator,
|
|
309
|
+
* '/api/*',
|
|
310
|
+
* {
|
|
311
|
+
* summary: 'Authentication middleware',
|
|
312
|
+
* description: 'Validates JWT tokens for API routes',
|
|
313
|
+
* tags: ['auth'],
|
|
314
|
+
* responses: {
|
|
315
|
+
* 401: {
|
|
316
|
+
* description: 'Unauthorized',
|
|
317
|
+
* content: {
|
|
318
|
+
* 'application/json': {
|
|
319
|
+
* schema: {
|
|
320
|
+
* type: 'object',
|
|
321
|
+
* properties: {
|
|
322
|
+
* error: { type: 'string' }
|
|
323
|
+
* }
|
|
324
|
+
* }
|
|
325
|
+
* }
|
|
326
|
+
* }
|
|
327
|
+
* }
|
|
328
|
+
* }
|
|
329
|
+
* },
|
|
330
|
+
* async (req, res, next) => {
|
|
331
|
+
* const token = req.headers.authorization?.split(' ')[1];
|
|
332
|
+
* if (!token) {
|
|
333
|
+
* res.status(401).json({ error: 'No token provided' });
|
|
334
|
+
* return;
|
|
335
|
+
* }
|
|
336
|
+
* try {
|
|
337
|
+
* const decoded = await verifyToken(token);
|
|
338
|
+
* req.user = decoded;
|
|
339
|
+
* next();
|
|
340
|
+
* } catch (err) {
|
|
341
|
+
* res.status(401).json({ error: 'Invalid token' });
|
|
342
|
+
* }
|
|
343
|
+
* }
|
|
344
|
+
* );
|
|
345
|
+
* ```
|
|
346
|
+
*/
|
|
347
|
+
declare const middleware: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "middleware", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => {
|
|
348
|
+
_typedHandler: true;
|
|
349
|
+
_path: Path;
|
|
350
|
+
contractDetails: _forklaunch_core_http.MiddlewareContractDetails<SV, Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>;
|
|
351
|
+
handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[];
|
|
352
|
+
};
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Creates an OPTIONS route handler with schema validation and type safety.
|
|
356
|
+
*
|
|
357
|
+
* @template SV - The schema validator type
|
|
358
|
+
* @template Path - The route path type (must start with '/')
|
|
359
|
+
* @template P - The path parameters type
|
|
360
|
+
* @template ResBodyMap - The response body map type
|
|
361
|
+
* @template ReqBody - The request body type
|
|
362
|
+
* @template ReqQuery - The request query parameters type
|
|
363
|
+
* @template ReqHeaders - The request headers type
|
|
364
|
+
* @template ResHeaders - The response headers type
|
|
365
|
+
* @template LocalsObj - The locals object type
|
|
366
|
+
*
|
|
367
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
368
|
+
* @param {Path} path - The route path
|
|
369
|
+
* @param {ContractDetails<SV, 'options', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
370
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
371
|
+
*
|
|
372
|
+
* @returns {void} - Returns nothing, registers the route with Hyper-Express
|
|
373
|
+
*
|
|
374
|
+
* @example
|
|
375
|
+
* ```typescript
|
|
376
|
+
* options(
|
|
377
|
+
* schemaValidator,
|
|
378
|
+
* '/users/:id',
|
|
379
|
+
* {
|
|
380
|
+
* summary: 'Get user options',
|
|
381
|
+
* description: 'Returns the allowed HTTP methods for the user resource',
|
|
382
|
+
* tags: ['users'],
|
|
383
|
+
* parameters: [
|
|
384
|
+
* {
|
|
385
|
+
* name: 'id',
|
|
386
|
+
* in: 'path',
|
|
387
|
+
* required: true,
|
|
388
|
+
* schema: { type: 'string' }
|
|
389
|
+
* }
|
|
390
|
+
* ],
|
|
391
|
+
* responses: {
|
|
392
|
+
* 200: {
|
|
393
|
+
* description: 'Allowed methods retrieved successfully',
|
|
394
|
+
* headers: {
|
|
395
|
+
* 'allow': {
|
|
396
|
+
* schema: { type: 'string' }
|
|
397
|
+
* }
|
|
398
|
+
* }
|
|
399
|
+
* }
|
|
400
|
+
* }
|
|
401
|
+
* },
|
|
402
|
+
* async (req, res) => {
|
|
403
|
+
* res.setHeader('allow', 'GET, PUT, PATCH, DELETE');
|
|
404
|
+
* res.status(200).end();
|
|
405
|
+
* }
|
|
406
|
+
* );
|
|
407
|
+
* ```
|
|
408
|
+
*/
|
|
409
|
+
declare const options: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "options", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "options", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* Creates a PATCH route handler with schema validation and type safety.
|
|
413
|
+
*
|
|
414
|
+
* @template SV - The schema validator type
|
|
415
|
+
* @template Path - The route path type (must start with '/')
|
|
416
|
+
* @template P - The path parameters type
|
|
417
|
+
* @template ResBodyMap - The response body map type
|
|
418
|
+
* @template ReqBody - The request body type
|
|
419
|
+
* @template ReqQuery - The request query parameters type
|
|
420
|
+
* @template ReqHeaders - The request headers type
|
|
421
|
+
* @template ResHeaders - The response headers type
|
|
422
|
+
* @template LocalsObj - The locals object type
|
|
423
|
+
*
|
|
424
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
425
|
+
* @param {Path} path - The route path
|
|
426
|
+
* @param {ContractDetails<SV, 'patch', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
427
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
428
|
+
*
|
|
429
|
+
* @returns {void} - Returns nothing, registers the route with Hyper-Express
|
|
430
|
+
*
|
|
431
|
+
* @example
|
|
432
|
+
* ```typescript
|
|
433
|
+
* patch(
|
|
434
|
+
* schemaValidator,
|
|
435
|
+
* '/users/:id',
|
|
436
|
+
* {
|
|
437
|
+
* summary: 'Update user partially',
|
|
438
|
+
* description: 'Updates specific fields of a user by ID',
|
|
439
|
+
* tags: ['users'],
|
|
440
|
+
* parameters: [
|
|
441
|
+
* {
|
|
442
|
+
* name: 'id',
|
|
443
|
+
* in: 'path',
|
|
444
|
+
* required: true,
|
|
445
|
+
* schema: { type: 'string' }
|
|
446
|
+
* }
|
|
447
|
+
* ],
|
|
448
|
+
* requestBody: {
|
|
449
|
+
* content: {
|
|
450
|
+
* 'application/json': {
|
|
451
|
+
* schema: {
|
|
452
|
+
* type: 'object',
|
|
453
|
+
* properties: {
|
|
454
|
+
* name: { type: 'string' },
|
|
455
|
+
* email: { type: 'string' }
|
|
456
|
+
* }
|
|
457
|
+
* }
|
|
458
|
+
* }
|
|
459
|
+
* }
|
|
460
|
+
* },
|
|
461
|
+
* responses: {
|
|
462
|
+
* 200: {
|
|
463
|
+
* description: 'User updated successfully',
|
|
464
|
+
* content: {
|
|
465
|
+
* 'application/json': {
|
|
466
|
+
* schema: {
|
|
467
|
+
* type: 'object',
|
|
468
|
+
* properties: {
|
|
469
|
+
* id: { type: 'string' },
|
|
470
|
+
* name: { type: 'string' },
|
|
471
|
+
* email: { type: 'string' }
|
|
472
|
+
* }
|
|
473
|
+
* }
|
|
474
|
+
* }
|
|
475
|
+
* }
|
|
476
|
+
* },
|
|
477
|
+
* 404: {
|
|
478
|
+
* description: 'User not found',
|
|
479
|
+
* content: {
|
|
480
|
+
* 'application/json': {
|
|
481
|
+
* schema: {
|
|
482
|
+
* type: 'object',
|
|
483
|
+
* properties: {
|
|
484
|
+
* error: { type: 'string' }
|
|
485
|
+
* }
|
|
486
|
+
* }
|
|
487
|
+
* }
|
|
488
|
+
* }
|
|
489
|
+
* }
|
|
490
|
+
* }
|
|
491
|
+
* },
|
|
492
|
+
* async (req, res) => {
|
|
493
|
+
* const { id } = req.params;
|
|
494
|
+
* const updates = await req.json();
|
|
495
|
+
* const user = await updateUser(id, updates);
|
|
496
|
+
* res.status(200).json(user);
|
|
497
|
+
* }
|
|
498
|
+
* );
|
|
499
|
+
* ```
|
|
500
|
+
*/
|
|
501
|
+
declare const patch: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "patch", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "patch", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
|
|
502
|
+
|
|
503
|
+
/**
|
|
504
|
+
* Creates a POST route handler with schema validation and type safety.
|
|
505
|
+
*
|
|
506
|
+
* @template SV - The schema validator type
|
|
507
|
+
* @template Path - The route path type (must start with '/')
|
|
508
|
+
* @template P - The path parameters type
|
|
509
|
+
* @template ResBodyMap - The response body map type
|
|
510
|
+
* @template ReqBody - The request body type
|
|
511
|
+
* @template ReqQuery - The request query parameters type
|
|
512
|
+
* @template ReqHeaders - The request headers type
|
|
513
|
+
* @template ResHeaders - The response headers type
|
|
514
|
+
* @template LocalsObj - The locals object type
|
|
515
|
+
*
|
|
516
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
517
|
+
* @param {Path} path - The route path
|
|
518
|
+
* @param {ContractDetails<SV, 'post', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
519
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
520
|
+
*
|
|
521
|
+
* @returns {void} - Returns nothing, registers the route with Hyper-Express
|
|
522
|
+
*
|
|
523
|
+
* @example
|
|
524
|
+
* ```typescript
|
|
525
|
+
* post(
|
|
526
|
+
* schemaValidator,
|
|
527
|
+
* '/users',
|
|
528
|
+
* {
|
|
529
|
+
* summary: 'Create user',
|
|
530
|
+
* description: 'Creates a new user',
|
|
531
|
+
* tags: ['users'],
|
|
532
|
+
* requestBody: {
|
|
533
|
+
* content: {
|
|
534
|
+
* 'application/json': {
|
|
535
|
+
* schema: {
|
|
536
|
+
* type: 'object',
|
|
537
|
+
* properties: {
|
|
538
|
+
* name: { type: 'string' },
|
|
539
|
+
* email: { type: 'string' },
|
|
540
|
+
* password: { type: 'string' }
|
|
541
|
+
* },
|
|
542
|
+
* required: ['name', 'email', 'password']
|
|
543
|
+
* }
|
|
544
|
+
* }
|
|
545
|
+
* }
|
|
546
|
+
* },
|
|
547
|
+
* responses: {
|
|
548
|
+
* 201: {
|
|
549
|
+
* description: 'User created successfully',
|
|
550
|
+
* content: {
|
|
551
|
+
* 'application/json': {
|
|
552
|
+
* schema: {
|
|
553
|
+
* type: 'object',
|
|
554
|
+
* properties: {
|
|
555
|
+
* id: { type: 'string' },
|
|
556
|
+
* name: { type: 'string' },
|
|
557
|
+
* email: { type: 'string' }
|
|
558
|
+
* }
|
|
559
|
+
* }
|
|
560
|
+
* }
|
|
561
|
+
* }
|
|
562
|
+
* },
|
|
563
|
+
* 400: {
|
|
564
|
+
* description: 'Invalid input',
|
|
565
|
+
* content: {
|
|
566
|
+
* 'application/json': {
|
|
567
|
+
* schema: {
|
|
568
|
+
* type: 'object',
|
|
569
|
+
* properties: {
|
|
570
|
+
* error: { type: 'string' }
|
|
571
|
+
* }
|
|
572
|
+
* }
|
|
573
|
+
* }
|
|
574
|
+
* }
|
|
575
|
+
* }
|
|
576
|
+
* }
|
|
577
|
+
* },
|
|
578
|
+
* async (req, res) => {
|
|
579
|
+
* const userData = await req.json();
|
|
580
|
+
* const user = await createUser(userData);
|
|
581
|
+
* res.status(201).json(user);
|
|
582
|
+
* }
|
|
583
|
+
* );
|
|
584
|
+
* ```
|
|
585
|
+
*/
|
|
586
|
+
declare const post: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "post", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "post", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
* Creates a PUT route handler with schema validation and type safety for Hyper-Express.
|
|
590
|
+
*
|
|
591
|
+
* @template SV - The schema validator type
|
|
592
|
+
* @template Path - The route path type (must start with '/')
|
|
593
|
+
* @template P - The path parameters type
|
|
594
|
+
* @template ResBodyMap - The response body map type
|
|
595
|
+
* @template ReqBody - The request body type
|
|
596
|
+
* @template ReqQuery - The request query parameters type
|
|
597
|
+
* @template ReqHeaders - The request headers type
|
|
598
|
+
* @template ResHeaders - The response headers type
|
|
599
|
+
* @template LocalsObj - The locals object type
|
|
600
|
+
*
|
|
601
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
602
|
+
* @param {Path} path - The route path
|
|
603
|
+
* @param {ContractDetails<SV, 'put', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
604
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
605
|
+
*
|
|
606
|
+
* @returns {void} - Returns nothing, registers the route with Hyper-Express
|
|
607
|
+
*
|
|
608
|
+
* @example
|
|
609
|
+
* ```typescript
|
|
610
|
+
* put(
|
|
611
|
+
* schemaValidator,
|
|
612
|
+
* '/users/:id',
|
|
613
|
+
* {
|
|
614
|
+
* summary: 'Update user',
|
|
615
|
+
* description: 'Updates a user by ID',
|
|
616
|
+
* tags: ['users'],
|
|
617
|
+
* pathParams: {
|
|
618
|
+
* id: { type: 'string' }
|
|
619
|
+
* },
|
|
620
|
+
* body: {
|
|
621
|
+
* type: 'object',
|
|
622
|
+
* properties: {
|
|
623
|
+
* name: { type: 'string' }
|
|
624
|
+
* }
|
|
625
|
+
* },
|
|
626
|
+
* responses: {
|
|
627
|
+
* 200: {
|
|
628
|
+
* description: 'User updated successfully',
|
|
629
|
+
* content: {
|
|
630
|
+
* 'application/json': {
|
|
631
|
+
* schema: {
|
|
632
|
+
* type: 'object',
|
|
633
|
+
* properties: {
|
|
634
|
+
* id: { type: 'string' },
|
|
635
|
+
* name: { type: 'string' }
|
|
636
|
+
* }
|
|
637
|
+
* }
|
|
638
|
+
* }
|
|
639
|
+
* }
|
|
640
|
+
* }
|
|
641
|
+
* }
|
|
642
|
+
* },
|
|
643
|
+
* async (req, res) => {
|
|
644
|
+
* const { id } = req.params;
|
|
645
|
+
* const { name } = req.body;
|
|
646
|
+
* // Update user logic
|
|
647
|
+
* res.json({ id, name });
|
|
648
|
+
* }
|
|
649
|
+
* );
|
|
650
|
+
* ```
|
|
651
|
+
*/
|
|
652
|
+
declare const put: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "put", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "put", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
|
|
653
|
+
|
|
654
|
+
/**
|
|
655
|
+
* Creates a TRACE route handler with schema validation and type safety.
|
|
656
|
+
*
|
|
657
|
+
* @template SV - The schema validator type
|
|
658
|
+
* @template Path - The route path type (must start with '/')
|
|
659
|
+
* @template P - The path parameters type
|
|
660
|
+
* @template ResBodyMap - The response body map type
|
|
661
|
+
* @template ReqBody - The request body type
|
|
662
|
+
* @template ReqQuery - The request query parameters type
|
|
663
|
+
* @template ReqHeaders - The request headers type
|
|
664
|
+
* @template ResHeaders - The response headers type
|
|
665
|
+
* @template LocalsObj - The locals object type
|
|
666
|
+
*
|
|
667
|
+
* @param {SV} schemaValidator - The schema validator instance
|
|
668
|
+
* @param {Path} path - The route path
|
|
669
|
+
* @param {ContractDetails<SV, 'trace', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>} contractDetails - The contract details for the route
|
|
670
|
+
* @param {...ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]} handlers - The route handlers
|
|
671
|
+
*
|
|
672
|
+
* @returns {void} - Returns nothing, registers the route with Hyper-Express
|
|
673
|
+
*
|
|
674
|
+
* @example
|
|
675
|
+
* ```typescript
|
|
676
|
+
* trace(
|
|
677
|
+
* schemaValidator,
|
|
678
|
+
* '/debug',
|
|
679
|
+
* {
|
|
680
|
+
* summary: 'Debug endpoint',
|
|
681
|
+
* description: 'Returns the request message for debugging purposes',
|
|
682
|
+
* tags: ['debug'],
|
|
683
|
+
* responses: {
|
|
684
|
+
* 200: {
|
|
685
|
+
* description: 'Request message returned successfully',
|
|
686
|
+
* content: {
|
|
687
|
+
* 'message/http': {
|
|
688
|
+
* schema: {
|
|
689
|
+
* type: 'string'
|
|
690
|
+
* }
|
|
691
|
+
* }
|
|
692
|
+
* }
|
|
693
|
+
* }
|
|
694
|
+
* }
|
|
695
|
+
* },
|
|
696
|
+
* async (req, res) => {
|
|
697
|
+
* const message = await req.text();
|
|
698
|
+
* res.setHeader('content-type', 'message/http');
|
|
699
|
+
* res.status(200).send(message);
|
|
700
|
+
* }
|
|
701
|
+
* );
|
|
702
|
+
* ```
|
|
703
|
+
*/
|
|
704
|
+
declare const trace: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "trace", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "trace", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
|
|
705
|
+
|
|
11
706
|
/**
|
|
12
707
|
* Represents an application built on top of Hyper-Express and Forklaunch.
|
|
13
708
|
* This class provides a high-performance web server implementation using uWebSockets.js
|
|
@@ -120,26 +815,16 @@ declare function forklaunchRouter<SV extends AnySchemaValidator, BasePath extend
|
|
|
120
815
|
}): Router<SV, BasePath>;
|
|
121
816
|
|
|
122
817
|
declare const handlers: {
|
|
123
|
-
any:
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
_typedHandler: true;
|
|
134
|
-
_path: Path;
|
|
135
|
-
contractDetails: _forklaunch_core_http.MiddlewareContractDetails<SV, Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, _forklaunch_hyper_express_fork.Request<LocalsObj>>;
|
|
136
|
-
handlers: _forklaunch_core_http.ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>[];
|
|
137
|
-
};
|
|
138
|
-
options: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends _forklaunch_core_http.ParamsObject<SV>, ResBodyMap extends _forklaunch_core_http.ResponsesObject<SV>, ReqBody extends _forklaunch_core_http.Body<SV>, ReqQuery extends _forklaunch_core_http.QueryObject<SV>, ReqHeaders extends _forklaunch_core_http.HeadersObject<SV>, ResHeaders extends _forklaunch_core_http.HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: _forklaunch_core_http.ContractDetails<SV, "options", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, _forklaunch_hyper_express_fork.Request<LocalsObj>>, ...handlers: _forklaunch_core_http.ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "options", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>;
|
|
139
|
-
patch: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends _forklaunch_core_http.ParamsObject<SV>, ResBodyMap extends _forklaunch_core_http.ResponsesObject<SV>, ReqBody extends _forklaunch_core_http.Body<SV>, ReqQuery extends _forklaunch_core_http.QueryObject<SV>, ReqHeaders extends _forklaunch_core_http.HeadersObject<SV>, ResHeaders extends _forklaunch_core_http.HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: _forklaunch_core_http.ContractDetails<SV, "patch", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, _forklaunch_hyper_express_fork.Request<LocalsObj>>, ...handlers: _forklaunch_core_http.ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "patch", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>;
|
|
140
|
-
post: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends _forklaunch_core_http.ParamsObject<SV>, ResBodyMap extends _forklaunch_core_http.ResponsesObject<SV>, ReqBody extends _forklaunch_core_http.Body<SV>, ReqQuery extends _forklaunch_core_http.QueryObject<SV>, ReqHeaders extends _forklaunch_core_http.HeadersObject<SV>, ResHeaders extends _forklaunch_core_http.HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: _forklaunch_core_http.ContractDetails<SV, "post", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, _forklaunch_hyper_express_fork.Request<LocalsObj>>, ...handlers: _forklaunch_core_http.ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "post", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>;
|
|
141
|
-
put: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends _forklaunch_core_http.ParamsObject<SV>, ResBodyMap extends _forklaunch_core_http.ResponsesObject<SV>, ReqBody extends _forklaunch_core_http.Body<SV>, ReqQuery extends _forklaunch_core_http.QueryObject<SV>, ReqHeaders extends _forklaunch_core_http.HeadersObject<SV>, ResHeaders extends _forklaunch_core_http.HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: _forklaunch_core_http.ContractDetails<SV, "put", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, _forklaunch_hyper_express_fork.Request<LocalsObj>>, ...handlers: _forklaunch_core_http.ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "put", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>;
|
|
142
|
-
trace: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends _forklaunch_core_http.ParamsObject<SV>, ResBodyMap extends _forklaunch_core_http.ResponsesObject<SV>, ReqBody extends _forklaunch_core_http.Body<SV>, ReqQuery extends _forklaunch_core_http.QueryObject<SV>, ReqHeaders extends _forklaunch_core_http.HeadersObject<SV>, ResHeaders extends _forklaunch_core_http.HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: _forklaunch_core_http.ContractDetails<SV, "trace", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, _forklaunch_hyper_express_fork.Request<LocalsObj>>, ...handlers: _forklaunch_core_http.ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "trace", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, _forklaunch_hyper_express_fork.Request<LocalsObj>, _forklaunch_hyper_express_fork.Response<LocalsObj>, _forklaunch_hyper_express_fork.MiddlewareNext>;
|
|
818
|
+
any: typeof any;
|
|
819
|
+
delete: typeof delete_;
|
|
820
|
+
get: typeof get;
|
|
821
|
+
head: typeof head;
|
|
822
|
+
middleware: typeof middleware;
|
|
823
|
+
options: typeof options;
|
|
824
|
+
patch: typeof patch;
|
|
825
|
+
post: typeof post;
|
|
826
|
+
put: typeof put;
|
|
827
|
+
trace: typeof trace;
|
|
143
828
|
};
|
|
144
829
|
|
|
145
830
|
export { type App, Application, Router, forklaunchExpress, forklaunchRouter, handlers };
|