@libp2p/interfaces v3.3.2
@libp2p/interfaces
Common code shared by the various libp2p interfaces
Table of contents
Install
$ npm i @libp2p/interfaces
Usage
AbortError
Throw an error with a .code
property of 'ABORT_ERR'
:
import { AbortError } from '@libp2p/interfaces/errors'
throw new AbortError()
Events
Typed events:
import { EventEmitter, CustomEvent } from '@libp2p/interfaces/events'
export interface MyEmitterEvents {
'some-event': CustomEvent<number>;
}
class MyEmitter extends EventEmitter<MyEmitterEvents> {
}
// later
const myEmitter = new MyEmitter()
myEmitter.addEventListener('some-event', (evt) => {
const num = evt.detail // <-- inferred as number
})
AbortOptions
import type { AbortOptions } from '@libp2p/interfaces'
Startable
Lifecycles for components
import { start, stop, isStartable } from '@libp2p/interfaces/startable'
import type { Startable } from '@libp2p/interfaces/startable'
class MyStartable implements Startable {
// .. implementation methods
}
const myStartable = new MyStartable()
isStartable(myStartable) // returns true
await start(myStartable)
await stop(myStartable)
API Docs
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.
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
11 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago