@zedtech/zedkit-nest 0.1.0 → 0.1.2
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/README.md +25 -9
- package/package.json +20 -2
package/README.md
CHANGED
|
@@ -1,6 +1,25 @@
|
|
|
1
1
|
# @zedtech/zedkit-nest
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@zedtech/zedkit-nest)
|
|
4
|
+
[](https://github.com/zedtech-fr/zedkit/blob/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
Boot a production-ready NestJS API from one factory call: validation,
|
|
7
|
+
logging, docs, throttling, errors and graceful shutdown included.
|
|
8
|
+
Original work by the same author.
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
Framework pieces are peer dependencies (one copy per app — required for
|
|
13
|
+
Nest DI). Install them alongside:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
pnpm add @zedtech/zedkit-nest @fastify/static @nestjs/common @nestjs/config \
|
|
17
|
+
@nestjs/core @nestjs/platform-fastify @nestjs/swagger @nestjs/throttler \
|
|
18
|
+
class-transformer class-validator fastify nestjs-pino pino pino-http \
|
|
19
|
+
reflect-metadata
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
4
23
|
|
|
5
24
|
`createNestApp({ module, envSchema, docs, ... })` wires only standard
|
|
6
25
|
pieces and returns the app ready to `listen()`:
|
|
@@ -43,15 +62,12 @@ const app = await createNestApp({
|
|
|
43
62
|
await app.listen(3000);
|
|
44
63
|
```
|
|
45
64
|
|
|
46
|
-
|
|
47
|
-
Nest DI). Install them alongside:
|
|
65
|
+
## When to use
|
|
48
66
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
reflect-metadata
|
|
54
|
-
```
|
|
67
|
+
Reach for this package when you start a NestJS API and want secure,
|
|
68
|
+
observable defaults instead of a blank schematic. For framework-free
|
|
69
|
+
server helpers (rate limiting, redaction) see
|
|
70
|
+
`@zedtech/zedkit-server` instead.
|
|
55
71
|
|
|
56
72
|
Rules (non-negotiable):
|
|
57
73
|
|
package/package.json
CHANGED
|
@@ -1,11 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zedtech/zedkit-nest",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public",
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
7
7
|
},
|
|
8
|
-
"description": "
|
|
8
|
+
"description": "Boot a production-ready NestJS app from one factory call: validation, logging, docs, throttling, errors and shutdown included. Original work by the same author.",
|
|
9
|
+
"keywords": [
|
|
10
|
+
"nestjs",
|
|
11
|
+
"nest",
|
|
12
|
+
"bootstrap",
|
|
13
|
+
"typescript",
|
|
14
|
+
"api",
|
|
15
|
+
"validation",
|
|
16
|
+
"logging",
|
|
17
|
+
"openapi",
|
|
18
|
+
"swagger",
|
|
19
|
+
"throttling",
|
|
20
|
+
"health-check",
|
|
21
|
+
"graceful-shutdown"
|
|
22
|
+
],
|
|
23
|
+
"homepage": "https://github.com/zedtech-fr/zedkit/tree/main/packages/nest",
|
|
24
|
+
"bugs": {
|
|
25
|
+
"url": "https://github.com/zedtech-fr/zedkit/issues"
|
|
26
|
+
},
|
|
9
27
|
"license": "MIT",
|
|
10
28
|
"repository": {
|
|
11
29
|
"type": "git",
|