fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-04-24 16:32:32 +00:00
Code Issues Projects Releases Wiki Activity

chore: add listener options

Browse Source
This commit is contained in:
Vasco Santos 2020-12-04 10:22:30 +01:00
parent 0b4b09ffee
commit e73646c893
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/transport/types.ts
View File

@ -3,18 +3,14 @@ import Multiaddr from 'multiaddr'
import Connection from '../connection/connection'
import { Sink } from '../stream-muxer/types'
export type DialOptions = {
signal?: AbortSignal
}
export interface TransportFactory<DialOptions extends { signal?: AbortSignal }> {
new(upgrader: Upgrader): Transport<DialOptions>;
export interface TransportFactory<DialOptions extends { signal?: AbortSignal }, ListenerOptions> {
new(upgrader: Upgrader): Transport<DialOptions, ListenerOptions>;
}
/**
* A libp2p transport is understood as something that offers a dial and listen interface to establish connections.
*/
export interface Transport <DialOptions extends { signal?: AbortSignal }> {
export interface Transport <DialOptions extends { signal?: AbortSignal }, ListenerOptions> {
/**
* Dial a given multiaddr.
*/
@ -22,7 +18,7 @@ export interface Transport <DialOptions extends { signal?: AbortSignal }> {
/**
* Create transport listeners.
*/
createListener(options: unknown, handler?: (connection: Connection) => void): Listener;
createListener(options: ListenerOptions, handler?: (connection: Connection) => void): Listener;
/**
* Takes a list of `Multiaddr`s and returns only valid addresses for the transport
*/