@jaypie/express 1.1.9 → 1.1.10
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/index.d.ts +68 -0
- package/package.json +3 -2
package/index.d.ts
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { Request, Response, NextFunction } from "express";
|
|
2
|
+
import { JaypieHandlerOptions } from "@jaypie/core";
|
|
3
|
+
|
|
4
|
+
export const EXPRESS: {
|
|
5
|
+
PATH: {
|
|
6
|
+
ANY: "*";
|
|
7
|
+
ID: "/:id";
|
|
8
|
+
ROOT: RegExp;
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
export interface CorsConfig {
|
|
13
|
+
origins?: string | string[];
|
|
14
|
+
overrides?: Record<string, unknown>;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export interface ExpressHandlerOptions extends JaypieHandlerOptions {
|
|
18
|
+
locals?: Record<string, unknown>;
|
|
19
|
+
name?: string;
|
|
20
|
+
setup?: ((req: Request, res: Response) => Promise<void>)[];
|
|
21
|
+
teardown?: ((req: Request, res: Response) => Promise<void>)[];
|
|
22
|
+
unavailable?: boolean;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export function cors(
|
|
26
|
+
config?: CorsConfig,
|
|
27
|
+
): (req: Request, res: Response, next: NextFunction) => void;
|
|
28
|
+
|
|
29
|
+
export function expressHandler<T>(
|
|
30
|
+
handler: (req: Request, res: Response, ...params: unknown[]) => Promise<T>,
|
|
31
|
+
options?: ExpressHandlerOptions,
|
|
32
|
+
): (req: Request, res: Response, ...params: unknown[]) => Promise<T>;
|
|
33
|
+
|
|
34
|
+
export function expressHttpCodeHandler(
|
|
35
|
+
statusCode?: number,
|
|
36
|
+
context?: ExpressHandlerOptions,
|
|
37
|
+
): (req: Request, res: Response) => Promise<Record<string, unknown> | null>;
|
|
38
|
+
|
|
39
|
+
// Pre-configured routes
|
|
40
|
+
export const badRequestRoute: (
|
|
41
|
+
req: Request,
|
|
42
|
+
res: Response,
|
|
43
|
+
) => Promise<Record<string, unknown>>;
|
|
44
|
+
export const echoRoute: (
|
|
45
|
+
req: Request,
|
|
46
|
+
res: Response,
|
|
47
|
+
) => Promise<Record<string, unknown>>;
|
|
48
|
+
export const forbiddenRoute: (
|
|
49
|
+
req: Request,
|
|
50
|
+
res: Response,
|
|
51
|
+
) => Promise<Record<string, unknown>>;
|
|
52
|
+
export const goneRoute: (
|
|
53
|
+
req: Request,
|
|
54
|
+
res: Response,
|
|
55
|
+
) => Promise<Record<string, unknown>>;
|
|
56
|
+
export const methodNotAllowedRoute: (
|
|
57
|
+
req: Request,
|
|
58
|
+
res: Response,
|
|
59
|
+
) => Promise<Record<string, unknown>>;
|
|
60
|
+
export const noContentRoute: (req: Request, res: Response) => Promise<null>;
|
|
61
|
+
export const notFoundRoute: (
|
|
62
|
+
req: Request,
|
|
63
|
+
res: Response,
|
|
64
|
+
) => Promise<Record<string, unknown>>;
|
|
65
|
+
export const notImplementedRoute: (
|
|
66
|
+
req: Request,
|
|
67
|
+
res: Response,
|
|
68
|
+
) => Promise<never>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jaypie/express",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.10",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"author": "Finlayson Studio",
|
|
6
6
|
"type": "module",
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
}
|
|
14
14
|
},
|
|
15
15
|
"main": "src/index.js",
|
|
16
|
+
"types": "index.d.ts",
|
|
16
17
|
"scripts": {
|
|
17
18
|
"build": "rollup --config",
|
|
18
19
|
"format": "npm run format:package && npm run format:lint",
|
|
@@ -43,5 +44,5 @@
|
|
|
43
44
|
"publishConfig": {
|
|
44
45
|
"access": "public"
|
|
45
46
|
},
|
|
46
|
-
"gitHead": "
|
|
47
|
+
"gitHead": "358428010fb0d5f130295fbe38b1aab2c1f89e5f"
|
|
47
48
|
}
|