@libp2p/tracked-map

@libp2p/tracked-map

Allows tracking of statistics while libp2p is running

Table of contents

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

Install

$ npm i @libp2p/tracked-map

Browser <script> tag

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

<script src="https://unpkg.com/@libp2p/tracked-map/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 { trackedMap } from '@libp2p/tracked-map'

const map = trackedMap<string, string>({ metrics })

map.set('key', 'value')

API Docs

• https://libp2p.github.io/js-libp2p-tracked-map

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.

Changelog

3.0.2 (2022-12-16)

Documentation

• update docs (6ad441d)