@elastic.io/batching-library - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3-dev.1

lib/client.ts

 import { AbstractStore } from './storage/IStore';
-import { Batch, BatchConfig, BatchItem, BatchStatus } from './entity/dto' ;
+import { Batch, BatchConfig, BatchItem, BatchStatus } from './entity/dto';
 import componentLogger from '@elastic.io/component-logger';
@@ -66,2 +66,11 @@
   }
+
+  /**
+   * Atomic Delete Batch
+   * @param batchId batch id
+   * @return Number of deleted items.
+   */
+  public async deleteBatchById(batchId: string): Promise<number> {
+    return await this.store.delete(batchId);
+  }
 }

out/client.d.ts

@@ -24,3 +24,3 @@ import { AbstractStore } from './storage/IStore';
     /**
-     * Atomic Get 'READY' batches and locks them (set status tu 'LOCKED')
+     * Atomic Get 'READY' batches and locks them (set status to 'LOCKED')
      */
@@ -38,3 +38,3 @@ getReadyBatches(): Promise<Batch[]>;
      * Ensures that item can be added to batch. If cant add to existing create new batch.
-     * Check batches after insett new item
+     * Check batches after insert new item
      * @param item batch item
@@ -44,3 +44,9 @@ * @return Batch with saved item.
     saveItem(item: BatchItem): Promise<Batch>;
+    /**
+     * Atomic Delete Batch
+     * @param batchId batch id
+     * @return Number of deleted items.
+     */
+    deleteBatchById(batchId: string): Promise<number>;
 }
 //# sourceMappingURL=client.d.ts.map

out/client.js

@@ -38,3 +38,3 @@ "use strict";
     /**
-     * Atomic Get 'READY' batches and locks them (set status tu 'LOCKED')
+     * Atomic Get 'READY' batches and locks them (set status to 'LOCKED')
      */
@@ -59,3 +59,3 @@ async getReadyBatches() {
      * Ensures that item can be added to batch. If cant add to existing create new batch.
-     * Check batches after insett new item
+     * Check batches after insert new item
      * @param item batch item
@@ -71,4 +71,12 @@ * @return Batch with saved item.
     }
+    /**
+     * Atomic Delete Batch
+     * @param batchId batch id
+     * @return Number of deleted items.
+     */
+    async deleteBatchById(batchId) {
+        return await this.store.delete(batchId);
+    }
 }
 exports.BatchClient = BatchClient;
 //# sourceMappingURL=client.js.map

out/storage/IStore.d.ts

@@ -105,5 +105,5 @@ /// <reference types="node" />
     /**
-     * @async update batches status by batch Configuration.
+     * @async update batches status by batch Configuration to READY.
      *
-     * @param batchConfig of batch Configuration.
+     * @param batchConfig batch Configuration.
      * @return number(count) of updated objects.
@@ -110,0 +110,0 @@ */

package.json

 {
   "name": "@elastic.io/batching-library",
-  "version": "0.0.2",
+  "version": "0.0.3-dev.1",
   "description": "Library for batching implementation on elastic.io",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/elasticio/batching-library#readme",

test/spec-integration/client.integration.spec.ts

@@ -216,2 +216,33 @@ import { MongoStore } from '../../lib/storage/impl/MongoStore';
   });
+
+  describe('delete Batch', () => {
+    let mgStore;
+    const options = Object.create(opt);
+    options.dbName = 'deleteBatch';
+    before(async () => {
+      mgStore = new MongoStore('deleteBatch', uri, options);
+      if (dropDB) {
+        const db = await mgStore.openConnection();
+        await db.useDb(options.dbName);
+        await db.dropDatabase();
+      }
+    });
+
+    it('should delete batch by id', async () => {
+      const conf = new BatchConfig(72, 30, 1000);
+      const client = new BatchClient(mgStore, conf);
+      const items = [
+          { num: { msg: 1 } },
+          { num: { msg: 2 } },
+      ];
+
+      const batch = await Promise.all(items.map(item => client.saveItem(new BatchItem(item.num.msg.toString(), item))));
+      const result = await client.deleteBatchById(batch[0].id);
+      expect(result).to.be.equal(1);
+    });
+
+    after(async () => {
+      await mgStore.close();
+    });
+  });
 });

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

170961

increased by1.08%

Number of package files

49

increased by2.08%

Lines of code

3342

increased by1.49%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes