@libp2p/utils 5.2.5 → 5.2.6-2122a713d

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.
Files changed (6) hide show
  1. package/README.md +20 -3
  2. package/dist/src/index.d.ts +3 -3
  3. package/dist/src/index.js +3 -3
  4. package/package.json +8 -7
  5. package/src/index.ts +3 -3
  6. package/dist/typedoc-urls.json +0 -72
package/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ # @libp2p/utils
2
+
1
3
  [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
2
4
  [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
3
5
  [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -7,6 +9,21 @@
7
9
 
8
10
  # About
9
11
 
12
+ <!--
13
+
14
+ !IMPORTANT!
15
+
16
+ Everything in this README between "# About" and "# Install" is automatically
17
+ generated and will be overwritten the next time the doc generator is run.
18
+
19
+ To make changes to this section, please update the @packageDocumentation section
20
+ of src/index.js or src/index.ts
21
+
22
+ To experiment with formatting, please run "npm run docs" from the root of this
23
+ repo and examine the changes made.
24
+
25
+ -->
26
+
10
27
  The libp2p ecosystem has lots of repos with it comes several problems like:
11
28
 
12
29
  - Domain logic dedupe - all modules shared a lot of logic like validation, streams handling, etc.
@@ -18,10 +35,10 @@ These problems are the motivation for this package, having shared logic in this
18
35
 
19
36
  Each function should be imported directly.
20
37
 
21
- ```js
22
- import ipAndPortToMultiaddr from '@libp2p/utils/ip-port-to-multiaddr'
38
+ ```TypeScript
39
+ import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'
23
40
 
24
- const ma = ipAndPortToMultiaddr('127.0.0.1', 9000)
41
+ const ma = ipPortToMultiaddr('127.0.0.1', 9000)
25
42
  ```
26
43
 
27
44
  # Install
package/dist/src/index.d.ts CHANGED
@@ -12,10 +12,10 @@
12
12
  *
13
13
  * Each function should be imported directly.
14
14
  *
15
- * ```js
16
- * import ipAndPortToMultiaddr from '@libp2p/utils/ip-port-to-multiaddr'
15
+ * ```TypeScript
16
+ * import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'
17
17
  *
18
- * const ma = ipAndPortToMultiaddr('127.0.0.1', 9000)
18
+ * const ma = ipPortToMultiaddr('127.0.0.1', 9000)
19
19
  * ```
20
20
  */
21
21
  export {};
package/dist/src/index.js CHANGED
@@ -12,10 +12,10 @@
12
12
  *
13
13
  * Each function should be imported directly.
14
14
  *
15
- * ```js
16
- * import ipAndPortToMultiaddr from '@libp2p/utils/ip-port-to-multiaddr'
15
+ * ```TypeScript
16
+ * import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'
17
17
  *
18
- * const ma = ipAndPortToMultiaddr('127.0.0.1', 9000)
18
+ * const ma = ipPortToMultiaddr('127.0.0.1', 9000)
19
19
  * ```
20
20
  */
21
21
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/utils",
3
- "version": "5.2.5",
3
+ "version": "5.2.6-2122a713d",
4
4
  "description": "Package to aggregate shared logic and dependencies for the libp2p ecosystem",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/utils#readme",
@@ -116,6 +116,7 @@
116
116
  "clean": "aegir clean",
117
117
  "lint": "aegir lint",
118
118
  "dep-check": "aegir dep-check",
119
+ "doc-check": "aegir doc-check",
119
120
  "build": "aegir build",
120
121
  "test": "aegir test",
121
122
  "test:chrome": "aegir test -t browser --cov",
@@ -127,8 +128,8 @@
127
128
  },
128
129
  "dependencies": {
129
130
  "@chainsafe/is-ip": "^2.0.2",
130
- "@libp2p/interface": "^1.1.3",
131
- "@libp2p/logger": "^4.0.6",
131
+ "@libp2p/interface": "1.1.4-2122a713d",
132
+ "@libp2p/logger": "4.0.7-2122a713d",
132
133
  "@multiformats/multiaddr": "^12.1.14",
133
134
  "@multiformats/multiaddr-matcher": "^1.1.2",
134
135
  "delay": "^6.0.0",
@@ -138,14 +139,14 @@
138
139
  "it-stream-types": "^2.0.1",
139
140
  "netmask": "^2.0.2",
140
141
  "p-defer": "^4.0.0",
141
- "race-event": "^1.1.0",
142
+ "race-event": "^1.2.0",
142
143
  "race-signal": "^1.0.2",
143
144
  "uint8arraylist": "^2.4.8"
144
145
  },
145
146
  "devDependencies": {
146
- "@libp2p/peer-id-factory": "^4.0.6",
147
+ "@libp2p/peer-id-factory": "4.0.7-2122a713d",
147
148
  "@types/netmask": "^2.0.5",
148
- "aegir": "^42.2.3",
149
+ "aegir": "^42.2.4",
149
150
  "delay": "^6.0.0",
150
151
  "it-all": "^3.0.4",
151
152
  "it-drain": "^3.0.5",
@@ -153,7 +154,7 @@
153
154
  "it-pipe": "^3.0.1",
154
155
  "sinon": "^17.0.1",
155
156
  "sinon-ts": "^2.0.0",
156
- "uint8arrays": "^5.0.1"
157
+ "uint8arrays": "^5.0.2"
157
158
  },
158
159
  "sideEffects": false
159
160
  }
package/src/index.ts CHANGED
@@ -12,10 +12,10 @@
12
12
  *
13
13
  * Each function should be imported directly.
14
14
  *
15
- * ```js
16
- * import ipAndPortToMultiaddr from '@libp2p/utils/ip-port-to-multiaddr'
15
+ * ```TypeScript
16
+ * import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'
17
17
  *
18
- * const ma = ipAndPortToMultiaddr('127.0.0.1', 9000)
18
+ * const ma = ipPortToMultiaddr('127.0.0.1', 9000)
19
19
  * ```
20
20
  */
21
21
 
package/dist/typedoc-urls.json DELETED
@@ -1,72 +0,0 @@
1
- {
2
- "AbstractStream": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.abstract_stream.AbstractStream.html",
3
- "./abstract-stream:AbstractStream": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.abstract_stream.AbstractStream.html",
4
- "AbstractStreamInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html",
5
- "./abstract-stream:AbstractStreamInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html",
6
- "certifiedAddressesFirst": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.certifiedAddressesFirst.html",
7
- "./address-sort:certifiedAddressesFirst": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.certifiedAddressesFirst.html",
8
- "circuitRelayAddressesLast": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.circuitRelayAddressesLast.html",
9
- "./address-sort:circuitRelayAddressesLast": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.circuitRelayAddressesLast.html",
10
- "defaultAddressSort": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.defaultAddressSort.html",
11
- "./address-sort:defaultAddressSort": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.defaultAddressSort.html",
12
- "publicAddressesFirst": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.publicAddressesFirst.html",
13
- "./address-sort:publicAddressesFirst": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.publicAddressesFirst.html",
14
- "arrayEquals": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.array_equals.arrayEquals.html",
15
- "./array-equals:arrayEquals": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.array_equals.arrayEquals.html",
16
- "closeSource": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.close_source.closeSource.html",
17
- "./close-source:closeSource": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.close_source.closeSource.html",
18
- "Errors": "https://libp2p.github.io/js-libp2p/variables/_libp2p_utils.ip_port_to_multiaddr.Errors.html",
19
- "./ip-port-to-multiaddr:Errors": "https://libp2p.github.io/js-libp2p/variables/_libp2p_utils.ip_port_to_multiaddr.Errors.html",
20
- "ipPortToMultiaddr": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html",
21
- "./ip-port-to-multiaddr:ipPortToMultiaddr": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html",
22
- "isPromise": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.is_promise.isPromise.html",
23
- "./is-promise:isPromise": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.is_promise.isPromise.html",
24
- "isLoopback": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html",
25
- "./multiaddr/is-loopback:isLoopback": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html",
26
- "isPrivate": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html",
27
- "./multiaddr/is-private:isPrivate": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html",
28
- "PeerQueue": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.peer_queue.PeerQueue.html",
29
- "./peer-queue:PeerQueue": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.peer_queue.PeerQueue.html",
30
- "PeerQueueJobOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html",
31
- "./peer-queue:PeerQueueJobOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html",
32
- "isPrivateIp": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.private_ip.isPrivateIp.html",
33
- "./private-ip:isPrivateIp": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.private_ip.isPrivateIp.html",
34
- "Queue": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.queue.Queue.html",
35
- "./queue:Queue": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.queue.Queue.html",
36
- "JobMatcher": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.JobMatcher.html",
37
- "./queue:JobMatcher": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.JobMatcher.html",
38
- "QueueAddOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.QueueAddOptions.html",
39
- "./queue:QueueAddOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.QueueAddOptions.html",
40
- "QueueEvents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.QueueEvents.html",
41
- "./queue:QueueEvents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.QueueEvents.html",
42
- "QueueInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.QueueInit.html",
43
- "./queue:QueueInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.QueueInit.html",
44
- "RunFunction": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.RunFunction.html",
45
- "./queue:RunFunction": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.queue.RunFunction.html",
46
- "JobStatus": "https://libp2p.github.io/js-libp2p/types/_libp2p_utils.queue.JobStatus.html",
47
- "./queue:JobStatus": "https://libp2p.github.io/js-libp2p/types/_libp2p_utils.queue.JobStatus.html",
48
- "RateLimiter": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.rate_limiter.RateLimiter.html",
49
- "./rate-limiter:RateLimiter": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.rate_limiter.RateLimiter.html",
50
- "GetKeySecDurationOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html",
51
- "./rate-limiter:GetKeySecDurationOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html",
52
- "RateLimiterInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html",
53
- "./rate-limiter:RateLimiterInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html",
54
- "RateLimiterResult": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html",
55
- "./rate-limiter:RateLimiterResult": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html",
56
- "RateRecord": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.rate_limiter.RateRecord.html",
57
- "./rate-limiter:RateRecord": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.rate_limiter.RateRecord.html",
58
- "StreamProperties": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html",
59
- "./stream-to-ma-conn:StreamProperties": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html",
60
- "streamToMaConnection": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html",
61
- "./stream-to-ma-conn:streamToMaConnection": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html",
62
- "CreateTrackedListInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html",
63
- "./tracked-list:CreateTrackedListInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html",
64
- "trackedList": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.tracked_list.trackedList.html",
65
- "./tracked-list:trackedList": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.tracked_list.trackedList.html",
66
- "CreateTrackedMapInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html",
67
- "./tracked-map:CreateTrackedMapInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html",
68
- "TrackedMapInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html",
69
- "./tracked-map:TrackedMapInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html",
70
- "trackedMap": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.tracked_map.trackedMap.html",
71
- "./tracked-map:trackedMap": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.tracked_map.trackedMap.html"
72
- }