libp2p-ts/peer-info/index.d.ts

46 lines
1.2 KiB
TypeScript
Raw Normal View History

2018-06-21 13:43:06 +02:00
// Type definitions for peer-info 0.14.1
// Project: https://github.com/libp2p/js-peer-info
2018-06-21 13:40:56 +02:00
// Definitions by: Jaco Greeff <https://github.com/jacogr>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference types="node"/>
2018-06-24 10:16:29 +02:00
/// <reference types="../multiaddr"/>
/// <reference types="../peer-id"/>
declare namespace PeerInfo {
type CreateCb = (error: Error | null, peerId?: PeerId) => any;
type CreateOptions = {
bits: number
};
type MultiAddrSet = {
size: number;
add (addr: MultiAddr): void;
addSafe (add: MultiAddr): void;
delete (addr: MultiAddr): void;
forEach (cb: (addr: MultiAddr, index: number) => any): void;
has (addr: MultiAddr): boolean;
replace (addr: MultiAddr, other: MultiAddr): void;
toArray (): MultiAddr[];
};
}
2018-06-21 13:40:56 +02:00
2018-06-24 10:16:29 +02:00
declare class PeerInfo {
2018-06-21 13:40:56 +02:00
constructor (id?: PeerId);
2018-06-24 10:16:29 +02:00
static create (optsOrCb: PeerInfo.CreateOptions | PeerInfo.CreateCb, cb?: PeerInfo.CreateCb): PeerInfo;
2018-06-21 13:40:56 +02:00
static isPeerInfo (info: any): info is PeerInfo;
2018-06-24 10:16:29 +02:00
multiaddrs: PeerInfo.MultiAddrSet;
2018-06-21 13:40:56 +02:00
connect (addr: MultiAddr): void;
disconnect (): void;
isConnected (): boolean;
}
2018-06-24 10:16:29 +02:00
declare module 'peer-info' {
export default PeerInfo;
2018-06-22 15:43:18 +02:00
}