@libp2p/logger 4.0.6 → 4.0.7-f71bc49bd

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,3 +1,5 @@
1
+ # @libp2p/logger
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
  A logger for libp2p based on the venerable [debug](https://www.npmjs.com/package/debug) module.
11
28
 
12
29
  ## Example
@@ -16,12 +33,16 @@ import { logger } from '@libp2p/logger'
16
33
 
17
34
  const log = logger('libp2p:my:component:name')
18
35
 
19
- log('something happened: %s', 'it was ok')
20
- log.error('something bad happened: %o', err)
36
+ try {
37
+ // an operation
38
+ log('something happened: %s', 'it was ok')
39
+ } catch (err) {
40
+ log.error('something bad happened: %o', err)
41
+ }
21
42
 
22
- log('with this peer: %p', aPeerId)
23
- log('and this base58btc: %b', aUint8Array)
24
- log('and this base32: %t', aUint8Array)
43
+ log('with this peer: %p', {})
44
+ log('and this base58btc: %b', Uint8Array.from([0, 1, 2, 3]))
45
+ log('and this base32: %t', Uint8Array.from([4, 5, 6, 7]))
25
46
  ```
26
47
 
27
48
  ```console
@@ -10,13 +10,18 @@
10
10
  *
11
11
  * const log = logger('libp2p:my:component:name')
12
12
  *
13
- * log('something happened: %s', 'it was ok')
14
- * log.error('something bad happened: %o', err)
13
+ * try {
14
+ * // an operation
15
+ * log('something happened: %s', 'it was ok')
16
+ * } catch (err) {
17
+ * log.error('something bad happened: %o', err)
18
+ * }
19
+ *
20
+ * log('with this peer: %p', {})
21
+ * log('and this base58btc: %b', Uint8Array.from([0, 1, 2, 3]))
22
+ * log('and this base32: %t', Uint8Array.from([4, 5, 6, 7]))
23
+ * ```
15
24
  *
16
- * log('with this peer: %p', aPeerId)
17
- * log('and this base58btc: %b', aUint8Array)
18
- * log('and this base32: %t', aUint8Array)
19
- * ```
20
25
  * ```console
21
26
  * $ DEBUG=libp2p:* node index.js
22
27
  * something happened: it was ok
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAOH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAwC/C,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,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACnC;AAeD,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,UAAU,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,iBAAiB,CAAM,GAAG,eAAe,CAErG;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAE,MAAM,EAAE,MAAM,GAAG,eAAe,CAM7D;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,IAAK,eAAe,CAMhD;AAED;;;;;;;;;;;;GAYG;AACH,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAOH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAwC/C,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,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACnC;AAeD,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,UAAU,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,iBAAiB,CAAM,GAAG,eAAe,CAErG;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAE,MAAM,EAAE,MAAM,GAAG,eAAe,CAM7D;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,IAAK,eAAe,CAMhD;AAED;;;;;;;;;;;;GAYG;AACH,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
@@ -10,13 +10,18 @@
10
10
  *
11
11
  * const log = logger('libp2p:my:component:name')
12
12
  *
13
- * log('something happened: %s', 'it was ok')
14
- * log.error('something bad happened: %o', err)
13
+ * try {
14
+ * // an operation
15
+ * log('something happened: %s', 'it was ok')
16
+ * } catch (err) {
17
+ * log.error('something bad happened: %o', err)
18
+ * }
19
+ *
20
+ * log('with this peer: %p', {})
21
+ * log('and this base58btc: %b', Uint8Array.from([0, 1, 2, 3]))
22
+ * log('and this base32: %t', Uint8Array.from([4, 5, 6, 7]))
23
+ * ```
15
24
  *
16
- * log('with this peer: %p', aPeerId)
17
- * log('and this base58btc: %b', aUint8Array)
18
- * log('and this base32: %t', aUint8Array)
19
- * ```
20
25
  * ```console
21
26
  * $ DEBUG=libp2p:* node index.js
22
27
  * something happened: it was ok
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;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;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAM3C,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;AAaD,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;AAOD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,UAAU,CAAE,MAAc,EAAE,UAAsC,EAAE;IAClF,OAAO,YAAY,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AACtD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAAE,MAAc;IAC1C,OAAO;QACL,YAAY,CAAE,IAAY;YACxB,OAAO,MAAM,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,CAAA;QACpC,CAAC;KACF,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO;QACL,YAAY,CAAE,IAAY;YACxB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAA;QACrB,CAAC;KACF,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,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,CAAC;QACjH,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAA;IAChC,CAAC;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;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;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAM3C,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;AAaD,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;AAOD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,UAAU,CAAE,MAAc,EAAE,UAAsC,EAAE;IAClF,OAAO,YAAY,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AACtD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAAE,MAAc;IAC1C,OAAO;QACL,YAAY,CAAE,IAAY;YACxB,OAAO,MAAM,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,CAAA;QACpC,CAAC;KACF,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO;QACL,YAAY,CAAE,IAAY;YACxB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAA;QACrB,CAAC;KACF,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,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,CAAC;QACjH,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAA;IAChC,CAAC;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": "4.0.6",
3
+ "version": "4.0.7-f71bc49bd",
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/main/packages/logger#readme",
@@ -43,6 +43,7 @@
43
43
  "clean": "aegir clean",
44
44
  "lint": "aegir lint",
45
45
  "dep-check": "aegir dep-check",
46
+ "doc-check": "aegir doc-check",
46
47
  "build": "aegir build",
47
48
  "test": "aegir test",
48
49
  "test:chrome": "aegir test -t browser --cov",
@@ -53,18 +54,18 @@
53
54
  "test:electron-main": "aegir test -t electron-main"
54
55
  },
55
56
  "dependencies": {
56
- "@libp2p/interface": "^1.1.3",
57
+ "@libp2p/interface": "1.1.4-f71bc49bd",
57
58
  "@multiformats/multiaddr": "^12.1.14",
58
59
  "debug": "^4.3.4",
59
- "interface-datastore": "^8.2.10",
60
- "multiformats": "^13.0.1"
60
+ "interface-datastore": "^8.2.11",
61
+ "multiformats": "^13.1.0"
61
62
  },
62
63
  "devDependencies": {
63
- "@libp2p/peer-id": "^4.0.6",
64
+ "@libp2p/peer-id": "4.0.7-f71bc49bd",
64
65
  "@types/debug": "^4.1.12",
65
- "aegir": "^42.2.3",
66
+ "aegir": "^42.2.4",
66
67
  "sinon": "^17.0.1",
67
- "uint8arrays": "^5.0.1"
68
+ "uint8arrays": "^5.0.2"
68
69
  },
69
70
  "sideEffects": false
70
71
  }
package/src/index.ts CHANGED
@@ -10,13 +10,18 @@
10
10
  *
11
11
  * const log = logger('libp2p:my:component:name')
12
12
  *
13
- * log('something happened: %s', 'it was ok')
14
- * log.error('something bad happened: %o', err)
13
+ * try {
14
+ * // an operation
15
+ * log('something happened: %s', 'it was ok')
16
+ * } catch (err) {
17
+ * log.error('something bad happened: %o', err)
18
+ * }
19
+ *
20
+ * log('with this peer: %p', {})
21
+ * log('and this base58btc: %b', Uint8Array.from([0, 1, 2, 3]))
22
+ * log('and this base32: %t', Uint8Array.from([4, 5, 6, 7]))
23
+ * ```
15
24
  *
16
- * log('with this peer: %p', aPeerId)
17
- * log('and this base58btc: %b', aUint8Array)
18
- * log('and this base32: %t', aUint8Array)
19
- * ```
20
25
  * ```console
21
26
  * $ DEBUG=libp2p:* node index.js
22
27
  * something happened: it was ok
@@ -1,22 +0,0 @@
1
- {
2
- "ComponentLogger": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_logger.ComponentLogger.html",
3
- ".:ComponentLogger": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_logger.ComponentLogger.html",
4
- "Logger": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_logger.Logger.html",
5
- ".:Logger": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_logger.Logger.html",
6
- "PeerLoggerOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_logger.PeerLoggerOptions.html",
7
- ".:PeerLoggerOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_logger.PeerLoggerOptions.html",
8
- "defaultLogger": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.defaultLogger.html",
9
- ".:defaultLogger": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.defaultLogger.html",
10
- "disable": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.disable.html",
11
- ".:disable": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.disable.html",
12
- "enable": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.enable.html",
13
- ".:enable": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.enable.html",
14
- "enabled": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.enabled.html",
15
- ".:enabled": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.enabled.html",
16
- "logger": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.logger-1.html",
17
- ".:logger": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.logger-1.html",
18
- "peerLogger": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.peerLogger.html",
19
- ".:peerLogger": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.peerLogger.html",
20
- "prefixLogger": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.prefixLogger.html",
21
- ".:prefixLogger": "https://libp2p.github.io/js-libp2p/functions/_libp2p_logger.prefixLogger.html"
22
- }