nuxt-processor 0.0.1 → 0.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 +29 -13
- package/dist/module.json +1 -1
- package/dist/module.mjs +1 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -3,19 +3,31 @@
|
|
|
3
3
|
[![npm version][npm-version-src]][npm-version-href]
|
|
4
4
|
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
5
5
|
[![License][license-src]][license-href]
|
|
6
|
-
[![Nuxt][nuxt-src]][nuxt-href]
|
|
7
6
|
|
|
8
7
|
Background job processing for Nuxt using BullMQ with a dedicated workers process.
|
|
9
8
|
|
|
9
|
+
<img width="763" height="321" alt="image" src="https://github.com/user-attachments/assets/f49d79a9-f99a-4612-b3bc-cad724475bf4" />
|
|
10
|
+
|
|
11
|
+
Note: This package is under very active development! Please consider creating issues if you run into anything!
|
|
12
|
+
|
|
10
13
|
- [✨ Release Notes](/CHANGELOG.md)
|
|
11
14
|
<!-- - [📖 Documentation](https://example.com) -->
|
|
12
15
|
|
|
13
16
|
## Features
|
|
14
17
|
|
|
15
18
|
- **Dedicated processing**: Workers run in a separate Node process – no coupling to your web server.
|
|
16
|
-
- **Scalability**: Run multiple worker processes and instances across machines
|
|
19
|
+
- **Scalability**: Run multiple worker processes and instances across machines.
|
|
17
20
|
- **Simple DX**: Define queues/workers in `server/queues` and `server/workers` using first-class helpers.
|
|
18
21
|
|
|
22
|
+
## Sections
|
|
23
|
+
|
|
24
|
+
- [Install](#install)
|
|
25
|
+
- [Define a queue and enqueue from your app](#define-a-queue-and-enqueue-from-your-app)
|
|
26
|
+
- [Define a worker](#define-a-worker)
|
|
27
|
+
- [Running](#running)
|
|
28
|
+
- [Bull Board](#bull-board)
|
|
29
|
+
- [Contribution](#contribution)
|
|
30
|
+
|
|
19
31
|
## Install
|
|
20
32
|
|
|
21
33
|
```bash
|
|
@@ -75,15 +87,21 @@ export default defineWorker({
|
|
|
75
87
|
- Start workers explicitly in a separate terminal:
|
|
76
88
|
|
|
77
89
|
```bash
|
|
78
|
-
# after a build
|
|
79
90
|
nuxi build
|
|
80
91
|
node .output/server/workers/index.mjs
|
|
81
92
|
```
|
|
82
93
|
|
|
83
|
-
##
|
|
94
|
+
## Bull Board
|
|
95
|
+
|
|
96
|
+
[Bull Board](https://github.com/felixmosh/bull-board) is an excellent UI for watching your queues, you can follow the setup in the playground to use it.
|
|
97
|
+
|
|
98
|
+
- [Server handler](./playground/server/handlers/bull-board.ts)
|
|
99
|
+
- [Route: `playground/server/routes/bull-board.ts`](./playground/server/routes/bull-board.ts)
|
|
100
|
+
- [Route: `playground/server/routes/bull-board/[...].ts`](./playground/server/routes/bull-board/%5B...%5D.ts)
|
|
84
101
|
|
|
85
|
-
|
|
102
|
+
Special thanks to [@genu](https://github.com/genu) for creating the H3 adapter.
|
|
86
103
|
|
|
104
|
+
For more help getting set up, see this Bull Board H3 adapter comment: <https://github.com/felixmosh/bull-board/pull/669#issuecomment-1883997968>.
|
|
87
105
|
|
|
88
106
|
## Contribution
|
|
89
107
|
|
|
@@ -118,14 +136,12 @@ The workers process handles graceful shutdown on `SIGINT/SIGTERM` and logs worke
|
|
|
118
136
|
|
|
119
137
|
|
|
120
138
|
<!-- Badges -->
|
|
121
|
-
[npm-version-src]: https://img.shields.io/npm/v/
|
|
122
|
-
[npm-version-href]: https://npmjs.com/package/
|
|
139
|
+
[npm-version-src]: https://img.shields.io/npm/v/nuxt-processor/latest.svg?style=flat&colorA=020420&colorB=00DC82
|
|
140
|
+
[npm-version-href]: https://npmjs.com/package/nuxt-processor
|
|
123
141
|
|
|
124
|
-
[npm-downloads-src]: https://img.shields.io/npm/dm/
|
|
125
|
-
[npm-downloads-href]: https://npm.chart.dev/
|
|
142
|
+
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-processor.svg?style=flat&colorA=020420&colorB=00DC82
|
|
143
|
+
[npm-downloads-href]: https://npm.chart.dev/nuxt-processor
|
|
126
144
|
|
|
127
|
-
[license-src]: https://img.shields.io/npm/l/
|
|
128
|
-
[license-href]: https://npmjs.com/package/
|
|
145
|
+
[license-src]: https://img.shields.io/npm/l/nuxt-processor.svg?style=flat&colorA=020420&colorB=00DC82
|
|
146
|
+
[license-href]: https://npmjs.com/package/nuxt-processor
|
|
129
147
|
|
|
130
|
-
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
|
|
131
|
-
[nuxt-href]: https://nuxt.com
|
package/dist/module.json
CHANGED
package/dist/module.mjs
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "nuxt-processor",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "Nuxt Processor",
|
|
5
5
|
"repository": "https://github.com/aidanhibbard/nuxt-processor",
|
|
6
6
|
"license": "MIT",
|
|
@@ -55,6 +55,7 @@
|
|
|
55
55
|
"@types/node": "latest",
|
|
56
56
|
"changelogen": "^0.6.2",
|
|
57
57
|
"eslint": "^9.34.0",
|
|
58
|
+
"happy-dom": "^18.0.1",
|
|
58
59
|
"nuxt": "^4.0.3",
|
|
59
60
|
"typescript": "~5.9.2",
|
|
60
61
|
"vitepress": "^2.0.0-alpha.12",
|