libp2p-ts/multiaddr/index.d.ts

// Type definitions for multiaddr 5.0.0
// Project: https://github.com/multiformats/js-multiaddr
// Definitions by: Jaco Greeff <https://github.com/jacogr>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node"/>
/// <reference types="../peer-id"/>

declare namespace MultiAddr {
    type Address = {
        family: string,
        host: string,
        port: string
    };

    type Options = Address & {
        transport: string
    };

    type Proto = {
        code: number,
        name: string,
        size: number
    };

    type Tuple = [ number, Buffer ];

    type TupleString = [ number, string ];
}

declare class MultiAddr {
    constructor (addr: MultiAddr | Buffer | string);

    static isMultiAddr (addr: any): addr is MultiAddr;
    static isName (other: MultiAddr): boolean;
    static fromNodeAddress (addr: { address: string, port: string }, transport: string): MultiAddr;

    decapsulate (other: MultiAddr): MultiAddr;
    encapsulate (other: MultiAddr): MultiAddr;
    equals (other: MultiAddr): boolean;
    getPeerId (): PeerId;
    inspect (): string;
    isThinWaistAddress (other?: MultiAddr): boolean;
    nodeAddress (): MultiAddr.Address;
    protos (): MultiAddr.Proto[];
    protoCodes (): number[];
    protoNames (): string[];
    stringTuples (): MultiAddr.TupleString[];
    tuples (): MultiAddr.Tuple[];
    toOptions (): MultiAddr.Options;
    toString (): string;
}

declare module 'multiaddr' {
export default MultiAddr;
}