@libp2p/logger 3.0.4 → 3.0.5

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.
package/README.md CHANGED
@@ -1,5 +1,3 @@
1
- # @libp2p/logger <!-- omit in toc -->
2
-
3
1
  [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
4
2
  [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
5
3
  [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -7,31 +5,7 @@
7
5
 
8
6
  > A logging component for use in js-libp2p modules
9
7
 
10
- ## Table of contents <!-- omit in toc -->
11
-
12
- - [Install](#install)
13
- - [Browser `<script>` tag](#browser-script-tag)
14
- - [Description](#description)
15
- - [Example](#example)
16
- - [API Docs](#api-docs)
17
- - [License](#license)
18
- - [Contribution](#contribution)
19
-
20
- ## Install
21
-
22
- ```console
23
- $ npm i @libp2p/logger
24
- ```
25
-
26
- ### Browser `<script>` tag
27
-
28
- Loading this module through a script tag will make it's exports available as `Libp2pLogger` in the global namespace.
29
-
30
- ```html
31
- <script src="https://unpkg.com/@libp2p/logger/dist/index.min.js"></script>
32
- ```
33
-
34
- ## Description
8
+ # About
35
9
 
36
10
  A map that reports it's size to the libp2p [Metrics](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/metrics#readme) system.
37
11
 
@@ -61,17 +35,31 @@ with this base58btc: Qmfoo
61
35
  with this base32: bafyfoo
62
36
  ```
63
37
 
64
- ## API Docs
38
+ # Install
39
+
40
+ ```console
41
+ $ npm i @libp2p/logger
42
+ ```
43
+
44
+ ## Browser `<script>` tag
45
+
46
+ Loading this module through a script tag will make it's exports available as `Libp2pLogger` in the global namespace.
47
+
48
+ ```html
49
+ <script src="https://unpkg.com/@libp2p/logger/dist/index.min.js"></script>
50
+ ```
51
+
52
+ # API Docs
65
53
 
66
54
  - <https://libp2p.github.io/js-libp2p/modules/_libp2p_logger.html>
67
55
 
68
- ## License
56
+ # License
69
57
 
70
58
  Licensed under either of
71
59
 
72
60
  - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
73
61
  - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
74
62
 
75
- ## Contribution
63
+ # Contribution
76
64
 
77
65
  Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
@@ -1,3 +1,33 @@
1
+ /**
2
+ * @packageDocumentation
3
+ *
4
+ * A map that reports it's size to the libp2p [Metrics](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/metrics#readme) system.
5
+ *
6
+ * If metrics are disabled a regular map is used.
7
+ *
8
+ * @example
9
+ *
10
+ * ```JavaScript
11
+ * import { logger } from '@libp2p/logger'
12
+ *
13
+ * const log = logger('libp2p:my:component:name')
14
+ *
15
+ * log('something happened: %s', 'it was ok')
16
+ * log.error('something bad happened: %o', err)
17
+ *
18
+ * log('with this peer: %p', aPeerId)
19
+ * log('and this base58btc: %b', aUint8Array)
20
+ * log('and this base32: %t', aUint8Array)
21
+ * ```
22
+ * ```console
23
+ * $ DEBUG=libp2p:* node index.js
24
+ * something happened: it was ok
25
+ * something bad happened: <stack trace>
26
+ * with this peer: 12D3Foo
27
+ * with this base58btc: Qmfoo
28
+ * with this base32: bafyfoo
29
+ * ```
30
+ */
1
31
  export interface Logger {
2
32
  (formatter: any, ...args: any[]): void;
3
33
  error(formatter: any, ...args: any[]): void;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AA4CA,MAAM,WAAW,MAAM;IACrB,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IACtC,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3C,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3C,OAAO,EAAE,OAAO,CAAA;CACjB;AAeD,wBAAgB,MAAM,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAa5C;AAED,wBAAgB,OAAO,IAAK,IAAI,CAE/B;AAED,wBAAgB,MAAM,CAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAEhD;AAED,wBAAgB,OAAO,CAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAEpD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AA8CH,MAAM,WAAW,MAAM;IACrB,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IACtC,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3C,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3C,OAAO,EAAE,OAAO,CAAA;CACjB;AAeD,wBAAgB,MAAM,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAa5C;AAED,wBAAgB,OAAO,IAAK,IAAI,CAE/B;AAED,wBAAgB,MAAM,CAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAEhD;AAED,wBAAgB,OAAO,CAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAEpD"}
package/dist/src/index.js CHANGED
@@ -1,3 +1,33 @@
1
+ /**
2
+ * @packageDocumentation
3
+ *
4
+ * A map that reports it's size to the libp2p [Metrics](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/metrics#readme) system.
5
+ *
6
+ * If metrics are disabled a regular map is used.
7
+ *
8
+ * @example
9
+ *
10
+ * ```JavaScript
11
+ * import { logger } from '@libp2p/logger'
12
+ *
13
+ * const log = logger('libp2p:my:component:name')
14
+ *
15
+ * log('something happened: %s', 'it was ok')
16
+ * log.error('something bad happened: %o', err)
17
+ *
18
+ * log('with this peer: %p', aPeerId)
19
+ * log('and this base58btc: %b', aUint8Array)
20
+ * log('and this base32: %t', aUint8Array)
21
+ * ```
22
+ * ```console
23
+ * $ DEBUG=libp2p:* node index.js
24
+ * something happened: it was ok
25
+ * something bad happened: <stack trace>
26
+ * with this peer: 12D3Foo
27
+ * with this base58btc: Qmfoo
28
+ * with this base32: bafyfoo
29
+ * ```
30
+ */
1
31
  import debug from 'debug';
2
32
  import { base32 } from 'multiformats/bases/base32';
3
33
  import { base58btc } from 'multiformats/bases/base58';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAMlD,oDAAoD;AACpD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAc,EAAU,EAAE;IAC9C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;AAC1D,CAAC,CAAA;AAED,oDAAoD;AACpD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAc,EAAU,EAAE;IAC9C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;AACvD,CAAC,CAAA;AAED,oDAAoD;AACpD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAc,EAAU,EAAE;IAC9C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;AACvD,CAAC,CAAA;AAED,4CAA4C;AAC5C,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAU,EAAU,EAAE;IAC1C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;AAC/C,CAAC,CAAA;AAED,wCAAwC;AACxC,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAO,EAAU,EAAE;IACvC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;AAC/C,CAAC,CAAA;AAED,kDAAkD;AAClD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAM,EAAU,EAAE;IACtC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;AAC/C,CAAC,CAAA;AAED,8CAA8C;AAC9C,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAa,EAAU,EAAE;IAC7C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;AAC/C,CAAC,CAAA;AASD,SAAS,oBAAoB,CAAE,SAAiB;IAC9C,MAAM,MAAM,GAAG,GAAS,EAAE,GAAE,CAAC,CAAA;IAC7B,MAAM,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,MAAM,CAAC,KAAK,GAAG,EAAE,CAAA;IACjB,MAAM,CAAC,IAAI,GAAG,CAAC,CAAA;IACf,MAAM,CAAC,GAAG,GAAG,GAAS,EAAE,GAAE,CAAC,CAAA;IAC3B,MAAM,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAA;IAC3B,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,MAAM,CAAA;IAE5B,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,UAAU,MAAM,CAAE,IAAY;IAClC,sCAAsC;IACtC,IAAI,KAAK,GAAmB,oBAAoB,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAA;IAEjE,mFAAmF;IACnF,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,EAAE;QAChH,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAA;KAC/B;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAChC,KAAK,EAAE,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC;QAC7B,KAAK;KACN,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,OAAO;IACrB,KAAK,CAAC,OAAO,EAAE,CAAA;AACjB,CAAC;AAED,MAAM,UAAU,MAAM,CAAE,UAAkB;IACxC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;AAC1B,CAAC;AAED,MAAM,UAAU,OAAO,CAAE,UAAkB;IACzC,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;AAClC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAMlD,oDAAoD;AACpD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAc,EAAU,EAAE;IAC9C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;AAC1D,CAAC,CAAA;AAED,oDAAoD;AACpD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAc,EAAU,EAAE;IAC9C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;AACvD,CAAC,CAAA;AAED,oDAAoD;AACpD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAc,EAAU,EAAE;IAC9C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;AACvD,CAAC,CAAA;AAED,4CAA4C;AAC5C,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAU,EAAU,EAAE;IAC1C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;AAC/C,CAAC,CAAA;AAED,wCAAwC;AACxC,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAO,EAAU,EAAE;IACvC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;AAC/C,CAAC,CAAA;AAED,kDAAkD;AAClD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAM,EAAU,EAAE;IACtC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;AAC/C,CAAC,CAAA;AAED,8CAA8C;AAC9C,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAa,EAAU,EAAE;IAC7C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;AAC/C,CAAC,CAAA;AASD,SAAS,oBAAoB,CAAE,SAAiB;IAC9C,MAAM,MAAM,GAAG,GAAS,EAAE,GAAE,CAAC,CAAA;IAC7B,MAAM,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,MAAM,CAAC,KAAK,GAAG,EAAE,CAAA;IACjB,MAAM,CAAC,IAAI,GAAG,CAAC,CAAA;IACf,MAAM,CAAC,GAAG,GAAG,GAAS,EAAE,GAAE,CAAC,CAAA;IAC3B,MAAM,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAA;IAC3B,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,MAAM,CAAA;IAE5B,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,UAAU,MAAM,CAAE,IAAY;IAClC,sCAAsC;IACtC,IAAI,KAAK,GAAmB,oBAAoB,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAA;IAEjE,mFAAmF;IACnF,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,EAAE;QAChH,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAA;KAC/B;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAChC,KAAK,EAAE,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC;QAC7B,KAAK;KACN,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,OAAO;IACrB,KAAK,CAAC,OAAO,EAAE,CAAA;AACjB,CAAC;AAED,MAAM,UAAU,MAAM,CAAE,UAAkB;IACxC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;AAC1B,CAAC;AAED,MAAM,UAAU,OAAO,CAAE,UAAkB;IACzC,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;AAClC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/logger",
3
- "version": "3.0.4",
3
+ "version": "3.0.5",
4
4
  "description": "A logging component for use in js-libp2p modules",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/logger#readme",
@@ -49,14 +49,14 @@
49
49
  "test:electron-main": "aegir test -t electron-main"
50
50
  },
51
51
  "dependencies": {
52
- "@libp2p/interface": "^0.1.4",
52
+ "@libp2p/interface": "^0.1.5",
53
53
  "@multiformats/multiaddr": "^12.1.5",
54
54
  "debug": "^4.3.4",
55
55
  "interface-datastore": "^8.2.0",
56
56
  "multiformats": "^12.0.1"
57
57
  },
58
58
  "devDependencies": {
59
- "@libp2p/peer-id": "^3.0.4",
59
+ "@libp2p/peer-id": "^3.0.5",
60
60
  "@types/debug": "^4.1.7",
61
61
  "aegir": "^41.0.2",
62
62
  "sinon": "^17.0.0",
package/src/index.ts CHANGED
@@ -1,3 +1,34 @@
1
+ /**
2
+ * @packageDocumentation
3
+ *
4
+ * A map that reports it's size to the libp2p [Metrics](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/metrics#readme) system.
5
+ *
6
+ * If metrics are disabled a regular map is used.
7
+ *
8
+ * @example
9
+ *
10
+ * ```JavaScript
11
+ * import { logger } from '@libp2p/logger'
12
+ *
13
+ * const log = logger('libp2p:my:component:name')
14
+ *
15
+ * log('something happened: %s', 'it was ok')
16
+ * log.error('something bad happened: %o', err)
17
+ *
18
+ * log('with this peer: %p', aPeerId)
19
+ * log('and this base58btc: %b', aUint8Array)
20
+ * log('and this base32: %t', aUint8Array)
21
+ * ```
22
+ * ```console
23
+ * $ DEBUG=libp2p:* node index.js
24
+ * something happened: it was ok
25
+ * something bad happened: <stack trace>
26
+ * with this peer: 12D3Foo
27
+ * with this base58btc: Qmfoo
28
+ * with this base32: bafyfoo
29
+ * ```
30
+ */
31
+
1
32
  import debug from 'debug'
2
33
  import { base32 } from 'multiformats/bases/base32'
3
34
  import { base58btc } from 'multiformats/bases/base58'