README.md

@libp2p/logger

A logging component for use in js-libp2p modules

Table of contents

• Install
  • Browser <script> tag
• Description
• Example
• API Docs
• License
• Contribution

Install

$ npm i @libp2p/logger

Browser <script> tag

Loading this module through a script tag will make it's exports available as Libp2pLogger in the global namespace.

<script src="https://unpkg.com/@libp2p/logger/dist/index.min.js"></script>

Description

A map that reports it's size to the libp2p Metrics system.

If metrics are disabled a regular map is used.

Example

import { logger } from '@libp2p/logger'

const log = logger('libp2p:my:component:name')

log('something happened: %s', 'it was ok')
log.error('something bad happened: %o', err)

log('with this peer: %p', aPeerId)
log('and this base58btc: %b', aUint8Array)
log('and this base32: %t', aUint8Array)

$ DEBUG=libp2p:* node index.js
something happened: it was ok
something bad happened: <stack trace>
with this peer: 12D3Foo
with this base58btc: Qmfoo
with this base32: bafyfoo

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_logger.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

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.