@diamir/nestjs-maintenance 11.0.0 → 11.0.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 +16 -16
- package/package.json +9 -3
package/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
|
|
2
|
-
<a href="https://webundsoehne.com" target="blank">
|
|
3
|
-
<img src="https://webundsoehne.com/wp-content/uploads/webundsoehne-logo.png" width="320" alt="Web und Söhne - Logo" />
|
|
4
|
-
</a>
|
|
5
|
-
</p>
|
|
6
|
-
Web & Söhne is Austria's leading expert in programming and implementing complex and large web projects.
|
|
1
|
+
# nestjs-maintenance
|
|
7
2
|
|
|
8
|
-
|
|
3
|
+
## Description
|
|
9
4
|
|
|
10
|
-
|
|
5
|
+
The maintenance module gives you the possibility to generate and remove a lock file,
|
|
6
|
+
as well as checking if the lock file exists and throwing a preconfigured `ServiceUnavailableException` error.
|
|
7
|
+
|
|
8
|
+
You may use the maintenance module anywhere in your project, e.g. for database migrations. (But make sure to access the same lock-file in each module)
|
|
9
|
+
|
|
10
|
+
---
|
|
11
11
|
|
|
12
12
|
<!-- TOC -->
|
|
13
13
|
* [nestjs-maintenance](#nestjs-maintenance)
|
|
@@ -15,15 +15,11 @@ Web & Söhne is Austria's leading expert in programming and implementing complex
|
|
|
15
15
|
* [Usage](#usage)
|
|
16
16
|
* [MaintenanceService](#maintenanceservice)
|
|
17
17
|
* [Decorator](#decorator)
|
|
18
|
-
|
|
18
|
+
* [Migration](#migration)
|
|
19
|
+
* [Links](#links)
|
|
19
20
|
<!-- TOC -->
|
|
20
21
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
The maintenance module gives you the possibility to generate and remove a lock file,
|
|
24
|
-
as well as checking if the lock file exists and throwing a preconfigured `ServiceUnavailableException` error.
|
|
25
|
-
|
|
26
|
-
You may use the maintenance module anywhere in your project, e.g. for database migrations. (But make sure to access the same lock-file in each module)
|
|
22
|
+
---
|
|
27
23
|
|
|
28
24
|
## Usage
|
|
29
25
|
|
|
@@ -68,8 +64,12 @@ Apply the `@UseMaintenanceLocker()` decorator on a method to wrap the original f
|
|
|
68
64
|
2. execute method
|
|
69
65
|
3. disable lock
|
|
70
66
|
|
|
71
|
-
|
|
67
|
+
# Migration
|
|
72
68
|
|
|
73
69
|
To migrate from the old `@webundsoehne/nestjs-util` to `@diamir/nestjs-maintenance`:
|
|
74
70
|
- replace the imports
|
|
75
71
|
- change the `MaintenanceModule` imports to use the `.forRoot` method
|
|
72
|
+
|
|
73
|
+
# Links
|
|
74
|
+
- [Diamir](https://diamir.io/)
|
|
75
|
+
- [nestjs](https://nestjs.com/)
|
package/package.json
CHANGED
|
@@ -1,14 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@diamir/nestjs-maintenance",
|
|
3
|
-
"version": "11.0.
|
|
4
|
-
"description": "",
|
|
3
|
+
"version": "11.0.2",
|
|
4
|
+
"description": "Nestjs maintenance middleware and lock",
|
|
5
5
|
"author": "Backend <backend@diamir.io>",
|
|
6
6
|
"repository": "https://github.com/tailoredmedia/backend-nx-skeleton",
|
|
7
7
|
"license": "ISC",
|
|
8
8
|
"publishConfig": {
|
|
9
9
|
"access": "public"
|
|
10
10
|
},
|
|
11
|
-
"keywords": [
|
|
11
|
+
"keywords": [
|
|
12
|
+
"diamir",
|
|
13
|
+
"nestjs",
|
|
14
|
+
"middleware",
|
|
15
|
+
"maintenance",
|
|
16
|
+
"lock"
|
|
17
|
+
],
|
|
12
18
|
"main": "./src/index.js",
|
|
13
19
|
"dependencies": {},
|
|
14
20
|
"peerDependencies": {
|