mongodash 2.1.0 → 2.1.1

package/README.md

@@ -1,8 +1,8 @@
 <br>
 
-<img src="https://raw.githubusercontent.com/VaclavObornik/mongodash/master/logo.png" alt="Mongodash" height="150" />
+<img src="logo.png" alt="Mongodash" height="150" />
 
-A modern JavaScript & Typescript MongoDB-based utility library. Includes **Reactive Tasks**, **Cron Tasks**, **Distributed Locks**, **Transactions**, and a **[Dashboard](https://vaclavobornik.github.io/mongodash/dashboard)**.
+A modern JavaScript & Typescript MongoDB-based utility library. Includes [**Reactive Tasks**](https://vaclavobornik.github.io/mongodash/reactive-tasks), [**Cron Tasks**](https://vaclavobornik.github.io/mongodash/cron-tasks), [**Distributed Locks**](https://vaclavobornik.github.io/mongodash/with-lock), [**Transactions**](https://vaclavobornik.github.io/mongodash/with-transaction), and a [**Dashboard**](https://vaclavobornik.github.io/mongodash/dashboard).
 
 [![Coverage Status](https://coveralls.io/repos/github/VaclavObornik/mongodash/badge.svg?branch=master)](https://coveralls.io/github/VaclavObornik/mongodash?branch=master)
 [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2FVaclavObornik%2Fmongodash%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/VaclavObornik/mongodash/master)
@@ -41,8 +41,8 @@ import { reactiveTask } from 'mongodash';
 await reactiveTask({
     task: 'on-user-update', 
     collection: 'users',
-    handler: async (doc) => {
-        console.log('User changed:', doc._id);
+    handler: async ({ docId }) => {
+        console.log('User changed:', docId);
     }
 });
 ```
@@ -120,3 +120,69 @@ import { getMongoClient } from 'mongodash';
 const mongoClient = getMongoClient();
 ```
 See detailed description [here](https://vaclavobornik.github.io/mongodash/getters).
+
+<br>
+
+## processInBatches
+
+```typescript
+import { processInBatches } from 'mongodash';
+
+await processInBatches(
+    db.collection('users'), 
+    { status: 'active' }, 
+    async (user) => {
+        // Transform user data
+        return {
+            updateOne: {
+                filter: { _id: user._id },
+                update: { $set: { processed: true } }
+            }
+        };
+    },
+    async (batchOps) => {
+        // Execute batch
+        await db.collection('users').bulkWrite(batchOps);
+    }
+);
+```
+See detailed description [here](https://vaclavobornik.github.io/mongodash/process-in-batches).
+
+<br>
+
+## Dashboard
+
+![Dashboard Screenshot](docs/assets/dashboard.png)
+
+```typescript
+import * as express from 'express';
+import { serveDashboard } from 'mongodash';
+
+const app = express();
+
+app.use('/dashboard', async (req, res, next) => {
+    // Check if mongodash handled the request
+    const handled = await serveDashboard(req, res);
+    if (!handled) {
+        next();
+    }
+});
+
+app.listen(3000);
+```
+
+See detailed description [here](https://vaclavobornik.github.io/mongodash/dashboard).
+
+<br>
+
+## getPrometheusMetrics
+
+```typescript
+import { getPrometheusMetrics } from 'mongodash';
+
+app.get('/metrics', async (req, res) => {
+    const registry = await getPrometheusMetrics();
+    res.set('Content-Type', registry.contentType);
+    res.end(await registry.metrics());
+});
+```