@libp2p/interface-mocks
Version:
Mock implementations of several libp2p interfaces
51 lines (32 loc) • 1.97 kB
Markdown
# @libp2p/interface-mocks <!-- omit in toc -->
[](http://libp2p.io/)
[](https://discuss.libp2p.io)
[](https://codecov.io/gh/libp2p/js-libp2p-interfaces)
[](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
> Mock implementations of several libp2p interfaces
## Table of contents <!-- omit in toc -->
- [Install](#install)
- [Browser `<script>` tag](#browser-script-tag)
- [Usage](#usage)
- [API Docs](#api-docs)
- [License](#license)
- [Contribution](#contribution)
## Install
```console
$ npm i @libp2p/interface-mocks
```
### Browser `<script>` tag
Loading this module through a script tag will make it's exports available as `Libp2pInterfaceMocks` in the global namespace.
```html
<script src="https://unpkg.com/@libp2p/interface-mocks/dist/index.min.js"></script>
```
## Usage
Each [interface](../interfaces) has its documentation on how to use the compliance tests and should be used as the source of truth.
## API Docs
- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_mocks.html>
## License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-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.