@web-ts-toolkit/express-json-router 0.5.0 → 0.6.1
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.mts +10 -1
- package/index.d.ts +10 -1
- package/package.json +4 -4
package/index.d.mts
CHANGED
|
@@ -17,6 +17,15 @@ type Endpoint = {
|
|
|
17
17
|
};
|
|
18
18
|
type ExpressRouter = ReturnType<typeof express.Router>;
|
|
19
19
|
type JsonRouterMiddlewares = JsonRouterCallback | JsonRouterCallback[];
|
|
20
|
+
/**
|
|
21
|
+
* Express router that serializes route handler return values as JSON and
|
|
22
|
+
* converts thrown `HttpError`s into structured error responses.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* import JsonRouter from '@web-ts-toolkit/express-json-router';
|
|
26
|
+
* const router = new JsonRouter('/api');
|
|
27
|
+
* router.get('/health', () => ({ ok: true }));
|
|
28
|
+
*/
|
|
20
29
|
declare class JsonRouter {
|
|
21
30
|
readonly methods: RouteMethod[];
|
|
22
31
|
readonly endpoints: Endpoint[];
|
|
@@ -69,7 +78,7 @@ declare class JsonRouter {
|
|
|
69
78
|
created: (data: unknown) => Created<unknown>;
|
|
70
79
|
accepted: (data: unknown) => Accepted<unknown>;
|
|
71
80
|
nonAuthoritativeInfo: (data: unknown) => NonAuthoritativeInfo<unknown>;
|
|
72
|
-
noContent: (
|
|
81
|
+
noContent: () => NoContent;
|
|
73
82
|
resetContent: (data: unknown) => ResetContent<unknown>;
|
|
74
83
|
partialContent: (data: unknown) => PartialContent<unknown>;
|
|
75
84
|
multiStatus: (data: unknown) => MultiStatus<unknown>;
|
package/index.d.ts
CHANGED
|
@@ -17,6 +17,15 @@ type Endpoint = {
|
|
|
17
17
|
};
|
|
18
18
|
type ExpressRouter = ReturnType<typeof express.Router>;
|
|
19
19
|
type JsonRouterMiddlewares = JsonRouterCallback | JsonRouterCallback[];
|
|
20
|
+
/**
|
|
21
|
+
* Express router that serializes route handler return values as JSON and
|
|
22
|
+
* converts thrown `HttpError`s into structured error responses.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* import JsonRouter from '@web-ts-toolkit/express-json-router';
|
|
26
|
+
* const router = new JsonRouter('/api');
|
|
27
|
+
* router.get('/health', () => ({ ok: true }));
|
|
28
|
+
*/
|
|
20
29
|
declare class JsonRouter {
|
|
21
30
|
readonly methods: RouteMethod[];
|
|
22
31
|
readonly endpoints: Endpoint[];
|
|
@@ -69,7 +78,7 @@ declare class JsonRouter {
|
|
|
69
78
|
created: (data: unknown) => Created<unknown>;
|
|
70
79
|
accepted: (data: unknown) => Accepted<unknown>;
|
|
71
80
|
nonAuthoritativeInfo: (data: unknown) => NonAuthoritativeInfo<unknown>;
|
|
72
|
-
noContent: (
|
|
81
|
+
noContent: () => NoContent;
|
|
73
82
|
resetContent: (data: unknown) => ResetContent<unknown>;
|
|
74
83
|
partialContent: (data: unknown) => PartialContent<unknown>;
|
|
75
84
|
multiStatus: (data: unknown) => MultiStatus<unknown>;
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@web-ts-toolkit/express-json-router",
|
|
3
3
|
"description": "Express router wrapper for return-value JSON responses",
|
|
4
4
|
"homepage": "https://web-ts-toolkit.pages.dev/docs/packages/express-json-router",
|
|
5
|
-
"version": "0.
|
|
5
|
+
"version": "0.6.1",
|
|
6
6
|
"sideEffects": false,
|
|
7
7
|
"keywords": [
|
|
8
8
|
"express",
|
|
@@ -26,9 +26,9 @@
|
|
|
26
26
|
"node": ">=20"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@web-ts-toolkit/express-response-handler": "0.
|
|
30
|
-
"@web-ts-toolkit/http-errors": "0.
|
|
31
|
-
"@web-ts-toolkit/utils": "0.
|
|
29
|
+
"@web-ts-toolkit/express-response-handler": "0.6.1",
|
|
30
|
+
"@web-ts-toolkit/http-errors": "0.6.1",
|
|
31
|
+
"@web-ts-toolkit/utils": "0.6.1",
|
|
32
32
|
"express": "^5.2.1"
|
|
33
33
|
},
|
|
34
34
|
"author": "Junmin Ahn",
|