@libp2p/perf 4.0.2 → 4.0.3-c258b35af

Sign up to get free protection for your applications and to get access to all the features.
Files changed (8) hide show
  1. package/README.md +1 -1
  2. package/dist/src/index.d.ts +7 -3
  3. package/dist/src/index.d.ts.map +1 -1
  4. package/dist/src/index.js +1 -1
  5. package/dist/src/index.js.map +1 -1
  6. package/package.json +5 -5
  7. package/src/index.ts +7 -3
  8. package/dist/typedoc-urls.json +0 -14
package/README.md CHANGED
@@ -24,7 +24,7 @@ repo and examine the changes made.
24
24
 
25
25
  -->
26
26
 
27
- The PerfService implements the [perf protocol](https://github.com/libp2p/specs/blob/master/perf/perf.md), which can be used to measure transfer performance within and across libp2p implementations.
27
+ The Perf service implements the [perf protocol](https://github.com/libp2p/specs/blob/master/perf/perf.md), which can be used to measure transfer performance within and across libp2p implementations.
28
28
 
29
29
  ## Example
30
30
 
package/dist/src/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * The {@link PerfService} implements the [perf protocol](https://github.com/libp2p/specs/blob/master/perf/perf.md), which can be used to measure transfer performance within and across libp2p implementations.
4
+ * The {@link Perf} service implements the [perf protocol](https://github.com/libp2p/specs/blob/master/perf/perf.md), which can be used to measure transfer performance within and across libp2p implementations.
5
5
  *
6
6
  * @example
7
7
  *
@@ -59,7 +59,9 @@ export interface PerfOptions extends AbortOptions {
59
59
  * connection, so a new connection will be opened for every performance run.
60
60
  *
61
61
  * To override this and re-use an existing connection if one is present, pass
62
- * `true` here. (default: false)
62
+ * `true` here.
63
+ *
64
+ * @default false
63
65
  */
64
66
  reuseExistingConnection?: boolean;
65
67
  }
@@ -78,7 +80,9 @@ export interface PerfInit {
78
80
  maxOutboundStreams?: number;
79
81
  runOnLimitedConnection?: boolean;
80
82
  /**
81
- * Data sent/received will be sent in chunks of this size (default: 64KiB)
83
+ * Data sent/received will be sent in chunks of this size
84
+ *
85
+ * @default 65536
82
86
  */
83
87
  writeBlockSize?: number;
84
88
  }
package/dist/src/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC;AAED,MAAM,WAAW,IAAI;IACnB,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAC,UAAU,CAAC,CAAA;CAClI;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,YAAY,GAAG,QAAQ,GAAG,cAAc,GAAG,OAAO,CAAA;IACxD,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,SAAS,CAAA;IACpB,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,wBAAgB,IAAI,CAAE,IAAI,GAAE,QAAa,GAAG,CAAC,UAAU,EAAE,cAAc,KAAK,IAAI,CAE/E"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C;;;;;;;;OAQG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC;AAED,MAAM,WAAW,IAAI;IACnB,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAC,UAAU,CAAC,CAAA;CAClI;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,YAAY,GAAG,QAAQ,GAAG,cAAc,GAAG,OAAO,CAAA;IACxD,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAEhC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,SAAS,CAAA;IACpB,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,wBAAgB,IAAI,CAAE,IAAI,GAAE,QAAa,GAAG,CAAC,UAAU,EAAE,cAAc,KAAK,IAAI,CAE/E"}
package/dist/src/index.js CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * The {@link PerfService} implements the [perf protocol](https://github.com/libp2p/specs/blob/master/perf/perf.md), which can be used to measure transfer performance within and across libp2p implementations.
4
+ * The {@link Perf} service implements the [perf protocol](https://github.com/libp2p/specs/blob/master/perf/perf.md), which can be used to measure transfer performance within and across libp2p implementations.
5
5
  *
6
6
  * @example
7
7
  *
package/dist/src/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AAEH,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAA;AA6CrD,MAAM,UAAU,IAAI,CAAE,OAAiB,EAAE;IACvC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AACxD,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AAEH,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAiDrD,MAAM,UAAU,IAAI,CAAE,OAAiB,EAAE;IACvC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AACxD,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/perf",
3
- "version": "4.0.2",
3
+ "version": "4.0.3-c258b35af",
4
4
  "description": "Implementation of Perf Protocol",
5
5
  "author": "@maschad / @marcopolo",
6
6
  "license": "Apache-2.0 OR MIT",
@@ -52,14 +52,14 @@
52
52
  "doc-check": "aegir doc-check"
53
53
  },
54
54
  "dependencies": {
55
- "@libp2p/interface": "^2.1.0",
56
- "@libp2p/interface-internal": "^2.0.2",
55
+ "@libp2p/interface": "2.1.1-c258b35af",
56
+ "@libp2p/interface-internal": "2.0.3-c258b35af",
57
57
  "@multiformats/multiaddr": "^12.2.3",
58
58
  "it-pushable": "^3.2.3"
59
59
  },
60
60
  "devDependencies": {
61
- "@libp2p/interface-compliance-tests": "^6.1.0",
62
- "@libp2p/logger": "^5.0.2",
61
+ "@libp2p/interface-compliance-tests": "6.1.1-c258b35af",
62
+ "@libp2p/logger": "5.0.3-c258b35af",
63
63
  "aegir": "^44.0.1",
64
64
  "it-last": "^3.0.6",
65
65
  "it-pair": "^2.0.6",
package/src/index.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * The {@link PerfService} implements the [perf protocol](https://github.com/libp2p/specs/blob/master/perf/perf.md), which can be used to measure transfer performance within and across libp2p implementations.
4
+ * The {@link Perf} service implements the [perf protocol](https://github.com/libp2p/specs/blob/master/perf/perf.md), which can be used to measure transfer performance within and across libp2p implementations.
5
5
  *
6
6
  * @example
7
7
  *
@@ -62,7 +62,9 @@ export interface PerfOptions extends AbortOptions {
62
62
  * connection, so a new connection will be opened for every performance run.
63
63
  *
64
64
  * To override this and re-use an existing connection if one is present, pass
65
- * `true` here. (default: false)
65
+ * `true` here.
66
+ *
67
+ * @default false
66
68
  */
67
69
  reuseExistingConnection?: boolean
68
70
  }
@@ -85,7 +87,9 @@ export interface PerfInit {
85
87
  runOnLimitedConnection?: boolean
86
88
 
87
89
  /**
88
- * Data sent/received will be sent in chunks of this size (default: 64KiB)
90
+ * Data sent/received will be sent in chunks of this size
91
+ *
92
+ * @default 65536
89
93
  */
90
94
  writeBlockSize?: number
91
95
  }
package/dist/typedoc-urls.json DELETED
@@ -1,14 +0,0 @@
1
- {
2
- "Perf": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.Perf.html",
3
- ".:Perf": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.Perf.html",
4
- "PerfComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.PerfComponents.html",
5
- ".:PerfComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.PerfComponents.html",
6
- "PerfInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.PerfInit.html",
7
- ".:PerfInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.PerfInit.html",
8
- "PerfOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.PerfOptions.html",
9
- ".:PerfOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.PerfOptions.html",
10
- "PerfOutput": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.PerfOutput.html",
11
- ".:PerfOutput": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_perf.PerfOutput.html",
12
- "perf": "https://libp2p.github.io/js-libp2p/functions/_libp2p_perf.perf-1.html",
13
- ".:perf": "https://libp2p.github.io/js-libp2p/functions/_libp2p_perf.perf-1.html"
14
- }