Skip to content

Files

Latest commit

78039b3 · Nov 5, 2022

History

History
This branch is 402 commits behind libp2p/js-libp2p-interfaces:master.

interface-transport-compliance-tests

@libp2p/interface-transport-compliance-tests

libp2p.io Discuss codecov CI

Compliance tests for implementations of the libp2p Transport interface

Table of contents

Install

$ npm i @libp2p/interface-transport-compliance-tests

Usage

import tests from '@libp2p/interface-transport-compliance-tests'

describe('your transport implementation', () => {
  tests({
    // Options should be passed to your implementation
    async setup (options) {
      return new YourImplementation()
    },
    async teardown () {
      // cleanup resources created by setup()
    }
  })
})

License

Licensed under either of

Contribute

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.