@codspeed/benchmark.js-plugin - npm Package Compare versions

Comparing version 2.3.1 to 3.0.0

dist/index.d.ts

@@ -0,1 +1,2 @@
+import { SetupInstrumentsRequestBody, SetupInstrumentsResponse } from '@codspeed/core';
 import Benchmark from 'benchmark';
@@ -33,4 +34,8 @@
 declare function withCodSpeed(suite: Benchmark.Suite): WithCodSpeedSuite;
+/**
+ * Dynamically setup the CodSpeed instruments.
+ */
+declare function setupInstruments(body: SetupInstrumentsRequestBody): Promise<SetupInstrumentsResponse>;
 
-export { type WithCodSpeedSuite, withCodSpeed };
+export { type WithCodSpeedSuite, setupInstruments, withCodSpeed };
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "@codspeed/benchmark.js-plugin",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "description": "Benchmark.js compatibility layer for CodSpeed",
@@ -30,3 +30,3 @@ "keywords": [
   "dependencies": {
-    "@codspeed/core": "^2.3.1",
+    "@codspeed/core": "^3.0.0",
     "lodash": "^4.17.10",
@@ -33,0 +33,0 @@ "stack-trace": "1.0.0-pre2"

README.md

@@ -15,7 +15,7 @@ <div align="center">
 
-Check out the [documentation](https://docs.codspeed.io/benchmarks/nodejs) for complete integration instructions.
+Check out the [documentation](https://docs.codspeed.io/benchmarks/nodejs/benchmark.js) for complete integration instructions.
 
 ## Installation
 
-First install the plugin [`@codspeed/benchmark.js-plugin`](https://www.npmjs.com/package/@codspeed/tinybench-plugin) and `benchmark.js` (if not already installed):
+First, install the plugin [`@codspeed/benchmark.js-plugin`](https://www.npmjs.com/package/@codspeed/benchmark.js-plugin) and `benchmark.js` (if not already installed):
 
@@ -87,2 +87,2 @@ ```sh
 
-You can now [run those benchmark in your CI](https://docs.codspeed.io/benchmarks/nodejs#running-the-benchmarks-in-your-ci) to continuously get consistent performance measurements.
+You can now [run those benchmarks in your CI](https://docs.codspeed.io/benchmarks/nodejs/benchmark.js#running-the-benchmarks-in-your-ci) to continuously get consistent performance measurements.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2901613

increased by0.12%

Lines of code

32826

increased by0.09%

Dependency changes

• + Added@codspeed/core@3.1.1(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaxios@1.7.7(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addedfollow-redirects@1.15.9(transitive)

• + Addedform-data@4.0.1(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedproxy-from-env@1.1.0(transitive)

• - Removed@codspeed/core@2.3.1(transitive)

• Updated@codspeed/core@^3.0.0