clear-router 2.8.4 → 2.8.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/dist/ClearRequest.d.cts +1 -1
- package/dist/ClearRequest.d.mts +1 -1
- package/dist/Controller.d.cts +1 -1
- package/dist/Controller.d.mts +1 -1
- package/dist/ResourceRoutes.cjs +1 -1
- package/dist/ResourceRoutes.d.cts +1 -1
- package/dist/ResourceRoutes.d.mts +1 -1
- package/dist/ResourceRoutes.mjs +1 -1
- package/dist/Route.d.cts +1 -1
- package/dist/Route.d.mts +1 -1
- package/dist/RouteGroup.d.cts +1 -1
- package/dist/RouteGroup.d.mts +1 -1
- package/dist/core/CoreRouter.cjs +2 -2
- package/dist/core/CoreRouter.d.cts +1 -1
- package/dist/core/CoreRouter.d.mts +1 -1
- package/dist/core/CoreRouter.mjs +2 -2
- package/dist/core/Request.d.cts +2 -2
- package/dist/core/Request.d.mts +2 -2
- package/dist/core/helpers.d.cts +1 -1
- package/dist/core/helpers.d.mts +1 -1
- package/dist/core/index.cjs +9 -0
- package/dist/core/index.mjs +2 -2
- package/dist/core/plugins.d.cts +1 -1
- package/dist/core/plugins.d.mts +1 -1
- package/dist/decorators/setup.d.mts +1 -0
- package/dist/express/router.d.cts +15 -15
- package/dist/express/router.d.mts +15 -15
- package/dist/fastify/router.d.cts +15 -15
- package/dist/fastify/router.d.mts +15 -15
- package/dist/h3/router.d.cts +15 -15
- package/dist/h3/router.d.mts +15 -15
- package/dist/hono/router.d.cts +15 -15
- package/dist/hono/router.d.mts +15 -15
- package/dist/index.d.cts +2 -2
- package/dist/index.d.mts +2 -2
- package/dist/koa/router.d.cts +17 -17
- package/dist/koa/router.d.mts +17 -17
- package/dist/types/basic.cjs +0 -0
- package/dist/types/basic.d.cts +4 -3
- package/dist/types/basic.d.mts +4 -3
- package/dist/types/express.cjs +0 -0
- package/dist/types/express.d.cts +3 -3
- package/dist/types/express.d.mts +3 -3
- package/dist/types/fastify.cjs +0 -0
- package/dist/types/fastify.d.cts +3 -3
- package/dist/types/fastify.d.mts +3 -3
- package/dist/types/h3.cjs +0 -0
- package/dist/types/h3.d.cts +8 -6
- package/dist/types/h3.d.mts +8 -6
- package/dist/types/hono.cjs +0 -0
- package/dist/types/hono.d.cts +4 -3
- package/dist/types/hono.d.mts +4 -3
- package/dist/types/koa.cjs +0 -0
- package/dist/types/koa.d.cts +4 -3
- package/dist/types/koa.d.mts +4 -3
- package/package.json +25 -7
- package/dist/Route-tq-rge1g.d.mts +0 -136
- package/dist/types/index.d.mts +0 -1
|
@@ -1,136 +0,0 @@
|
|
|
1
|
-
import { Middleware } from "./types/express.mjs";
|
|
2
|
-
import { Middleware as Middleware$1 } from "./types/fastify.mjs";
|
|
3
|
-
import { Middleware as Middleware$2 } from "./types/h3.mjs";
|
|
4
|
-
import { Middleware as Middleware$3 } from "./types/hono.mjs";
|
|
5
|
-
import { Middleware as Middleware$4 } from "./types/koa.mjs";
|
|
6
|
-
import { HttpMethod, RequestData } from "./types/basic.mjs";
|
|
7
|
-
|
|
8
|
-
//#region src/Contracts.d.ts
|
|
9
|
-
/**
|
|
10
|
-
* HTTP context passed to route handlers
|
|
11
|
-
*/
|
|
12
|
-
interface ClearHttpContext {}
|
|
13
|
-
interface RouteParameter {
|
|
14
|
-
name: string;
|
|
15
|
-
field?: string;
|
|
16
|
-
optional: boolean;
|
|
17
|
-
}
|
|
18
|
-
//#endregion
|
|
19
|
-
//#region src/core/Request.d.ts
|
|
20
|
-
declare class Request<X = any, M = any> extends ClearRequest<X, M> {
|
|
21
|
-
original?: any;
|
|
22
|
-
method: string;
|
|
23
|
-
path: string;
|
|
24
|
-
url: string;
|
|
25
|
-
headers: Headers | Record<string, any>;
|
|
26
|
-
constructor(init?: Partial<Request<X, M>> & {
|
|
27
|
-
body?: RequestData;
|
|
28
|
-
query?: RequestData;
|
|
29
|
-
params?: RequestData;
|
|
30
|
-
route?: Route<X, M>;
|
|
31
|
-
});
|
|
32
|
-
getBody(): RequestData;
|
|
33
|
-
header(name: string): string;
|
|
34
|
-
param(name: string): any;
|
|
35
|
-
input(name: string): any;
|
|
36
|
-
is(method: HttpMethod | string): boolean;
|
|
37
|
-
}
|
|
38
|
-
//#endregion
|
|
39
|
-
//#region src/core/Response.d.ts
|
|
40
|
-
declare class Response {
|
|
41
|
-
[key: string]: any;
|
|
42
|
-
body: any;
|
|
43
|
-
headers: Headers;
|
|
44
|
-
sent: boolean;
|
|
45
|
-
statusCode: number;
|
|
46
|
-
statusText: string;
|
|
47
|
-
constructor(init?: Partial<Response | globalThis.Response>);
|
|
48
|
-
status(code: number): this;
|
|
49
|
-
setStatusText(text: string): this;
|
|
50
|
-
code(code: number): this;
|
|
51
|
-
setHeader(name: string, value: string): this;
|
|
52
|
-
header(name: string, value: string): this;
|
|
53
|
-
set(name: string, value: string): this;
|
|
54
|
-
type(contentType: string): this;
|
|
55
|
-
send(body?: any): this;
|
|
56
|
-
json(body: any): this;
|
|
57
|
-
html(body: string): this;
|
|
58
|
-
text(body: string): this;
|
|
59
|
-
noContent(): this;
|
|
60
|
-
}
|
|
61
|
-
//#endregion
|
|
62
|
-
//#region src/ClearRequest.d.ts
|
|
63
|
-
declare class ClearRequest<X = any, M = Middleware$2 | Middleware | Middleware$1 | Middleware$3 | Middleware$4> {
|
|
64
|
-
[key: string]: any;
|
|
65
|
-
/**
|
|
66
|
-
* @param body - Parsed request body
|
|
67
|
-
*/
|
|
68
|
-
body: RequestData;
|
|
69
|
-
/**
|
|
70
|
-
* @param query - Parsed query parameters
|
|
71
|
-
*/
|
|
72
|
-
query: RequestData;
|
|
73
|
-
/**
|
|
74
|
-
* @param params - Parsed route parameters
|
|
75
|
-
*/
|
|
76
|
-
params: RequestData;
|
|
77
|
-
route: Route<X, M>;
|
|
78
|
-
constructor(init?: Partial<ClearRequest>);
|
|
79
|
-
}
|
|
80
|
-
//#endregion
|
|
81
|
-
//#region src/Route.d.ts
|
|
82
|
-
/**
|
|
83
|
-
* @class clear-router Route
|
|
84
|
-
* @description A route describes a single enpoint on clear-router
|
|
85
|
-
* @author 3m1n3nc3
|
|
86
|
-
* @repository https://github.com/arkstack-tmp/clear-router
|
|
87
|
-
*/
|
|
88
|
-
declare class Route<X = any, M = Middleware$2 | Middleware, H = any> {
|
|
89
|
-
ctx: X;
|
|
90
|
-
body: RequestData;
|
|
91
|
-
query: RequestData;
|
|
92
|
-
params: RequestData;
|
|
93
|
-
clearRequest: ClearRequest;
|
|
94
|
-
methods: HttpMethod[];
|
|
95
|
-
path: string;
|
|
96
|
-
registrationPaths: string[];
|
|
97
|
-
parameters: RouteParameter[];
|
|
98
|
-
routeName?: string;
|
|
99
|
-
handler: H;
|
|
100
|
-
middlewares: M[];
|
|
101
|
-
controllerName?: string;
|
|
102
|
-
actionName?: string;
|
|
103
|
-
handlerType: 'function' | 'controller';
|
|
104
|
-
middlewareCount: number;
|
|
105
|
-
constructor(methods: HttpMethod[], path: string, handler: H, middlewares?: M[], options?: {
|
|
106
|
-
registrationPaths?: string[];
|
|
107
|
-
parameters?: RouteParameter[];
|
|
108
|
-
onName?: (name: string, route: Route<X, M, H>, previousName?: string) => void;
|
|
109
|
-
normalizeMiddleware?: (middleware: M) => M;
|
|
110
|
-
});
|
|
111
|
-
private onName?;
|
|
112
|
-
private normalizeMiddleware?;
|
|
113
|
-
/**
|
|
114
|
-
* Set the route name
|
|
115
|
-
*
|
|
116
|
-
* @param name
|
|
117
|
-
* @returns
|
|
118
|
-
*/
|
|
119
|
-
name(name: string): this;
|
|
120
|
-
/**
|
|
121
|
-
* Register one or more middleware that will be executed before the route.
|
|
122
|
-
*
|
|
123
|
-
* @param middlewares
|
|
124
|
-
* @returns
|
|
125
|
-
*/
|
|
126
|
-
middleware(middlewares: M[] | M): this;
|
|
127
|
-
/**
|
|
128
|
-
* Get the path generated and accessible by this route
|
|
129
|
-
*
|
|
130
|
-
* @param params
|
|
131
|
-
* @returns
|
|
132
|
-
*/
|
|
133
|
-
toPath(params?: RequestData): string;
|
|
134
|
-
}
|
|
135
|
-
//#endregion
|
|
136
|
-
export { ClearHttpContext as i, Response as n, Request as r, Route as t };
|
package/dist/types/index.d.mts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import { ApiResourceMiddleware, ClassMiddleware, ControllerHandler, FileImporter, HttpMethod, MaybePromise, MiddlewareClass, MiddlewareHandle, MiddlewareInstance, RequestData, ResourceAction, ResourceRouteDefinition, ResourceRouteRegistrar, ResourceRouteRemover, ResourceRoutesOptions, RouteGroupCallback, RouteGroupCondition, RouteGroupContext, RouteGroupEntry, RouteGroupOptions, RouteGroupSource, RouterConfig } from "./basic.mjs";
|