From 5215e40a250afd22e64176f85cae02f98e5a717c Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Thu, 28 Dec 2023 07:54:08 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- classes/index.MultiaddrFilter.html | 4 +-- functions/convert.convert.html | 2 +- functions/convert.convertToBytes.html | 2 +- functions/convert.convertToIpNet.html | 2 +- functions/convert.convertToString.html | 2 +- functions/index.fromNodeAddress.html | 2 +- functions/index.isMultiaddr.html | 2 +- functions/index.isName.html | 2 +- functions/index.multiaddr-1.html | 2 +- functions/index.protocols.html | 2 +- functions/resolvers.dnsaddrResolver.html | 2 +- interfaces/index.AbortOptions.html | 4 +-- interfaces/index.Multiaddr.html | 38 ++++++++++++------------ interfaces/index.MultiaddrObject.html | 4 +-- interfaces/index.NodeAddress.html | 4 +-- interfaces/index.Protocol.html | 4 +-- interfaces/index.Resolver.html | 2 +- modules/convert.html | 2 +- modules/index.html | 2 +- modules/resolvers.html | 2 +- types/index.MultiaddrInput.html | 2 +- types/index.StringTuple.html | 2 +- types/index.Tuple.html | 2 +- variables/index.resolvers.html | 2 +- 24 files changed, 47 insertions(+), 47 deletions(-) diff --git a/classes/index.MultiaddrFilter.html b/classes/index.MultiaddrFilter.html index d8b000fc..69bbdb90 100644 --- a/classes/index.MultiaddrFilter.html +++ b/classes/index.MultiaddrFilter.html @@ -4,8 +4,8 @@ multiaddr is in a ipcidr range.

Example

import { multiaddr, MultiaddrFilter } from '@multiformats/multiaddr'

const range = multiaddr('/ip4/192.168.10.10/ipcidr/24')
const filter = new MultiaddrFilter(range)

const input = multiaddr('/ip4/192.168.10.2/udp/60')
console.info(filter.contains(input)) // true
-

Constructors

constructor +

Constructors

constructor

Properties

multiaddr netmask

Methods

contains -

Constructors

constructor

Properties

Private Readonly multiaddr

multiaddr: Multiaddr

Private Readonly netmask

netmask: IpNet

Methods

contains

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly multiaddr

multiaddr: Multiaddr

Private Readonly netmask

netmask: IpNet

Methods

contains

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/convert.convert.html b/functions/convert.convert.html index e09c5004..6a85caf2 100644 --- a/functions/convert.convert.html +++ b/functions/convert.convert.html @@ -1,2 +1,2 @@ convert | @multiformats/multiaddr

Function convert

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Uint8Array

  • convert(proto, a): string

  • Parameters

    Returns string

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/convert.convertToBytes.html b/functions/convert.convertToBytes.html index 09b4b8e3..e6d46c64 100644 --- a/functions/convert.convertToBytes.html +++ b/functions/convert.convertToBytes.html @@ -1 +1 @@ -convertToBytes | @multiformats/multiaddr

    Function convertToBytes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +convertToBytes | @multiformats/multiaddr

    Function convertToBytes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/convert.convertToIpNet.html b/functions/convert.convertToIpNet.html index 0be3b368..fde26f69 100644 --- a/functions/convert.convertToIpNet.html +++ b/functions/convert.convertToIpNet.html @@ -1 +1 @@ -convertToIpNet | @multiformats/multiaddr

    Function convertToIpNet

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +convertToIpNet | @multiformats/multiaddr

    Function convertToIpNet

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/convert.convertToString.html b/functions/convert.convertToString.html index 46a85fe9..bd37e61f 100644 --- a/functions/convert.convertToString.html +++ b/functions/convert.convertToString.html @@ -1,2 +1,2 @@ convertToString | @multiformats/multiaddr

    Function convertToString

    • convertToString(proto, buf): string

    • Convert [code,Uint8Array] to string

      -

      Parameters

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.fromNodeAddress.html b/functions/index.fromNodeAddress.html index 59c95d79..af68d309 100644 --- a/functions/index.fromNodeAddress.html +++ b/functions/index.fromNodeAddress.html @@ -1,4 +1,4 @@ fromNodeAddress | @multiformats/multiaddr

    Function fromNodeAddress

    • fromNodeAddress(addr, transport): Multiaddr

    • Creates a Multiaddr from a node-friendly address object

      Parameters

      Returns Multiaddr

      Example

      import { fromNodeAddress } from '@multiformats/multiaddr'

      fromNodeAddress({address: '127.0.0.1', port: '4001'}, 'tcp')
      // Multiaddr(/ip4/127.0.0.1/tcp/4001)
      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.isMultiaddr.html b/functions/index.isMultiaddr.html index b584df10..56980f45 100644 --- a/functions/index.isMultiaddr.html +++ b/functions/index.isMultiaddr.html @@ -1,4 +1,4 @@ isMultiaddr | @multiformats/multiaddr

    Function isMultiaddr

    • isMultiaddr(value): value is Multiaddr

    • Check if object is a Multiaddr instance

      Parameters

      • value: any

      Returns value is Multiaddr

      Example

      import { isMultiaddr, multiaddr } from '@multiformats/multiaddr'

      isMultiaddr(5)
      // false
      isMultiaddr(multiaddr('/ip4/127.0.0.1'))
      // true
      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.isName.html b/functions/index.isName.html index 476ced4b..387040f1 100644 --- a/functions/index.isName.html +++ b/functions/index.isName.html @@ -1,4 +1,4 @@ isName | @multiformats/multiaddr

    Function isName

    • isName(addr): boolean

    • Returns if something is a Multiaddr that is a resolvable name

      Parameters

      Returns boolean

      Example

      import { isName, multiaddr } from '@multiformats/multiaddr'

      isName(multiaddr('/ip4/127.0.0.1'))
      // false
      isName(multiaddr('/dns/ipfs.io'))
      // true
      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.multiaddr-1.html b/functions/index.multiaddr-1.html index 5e27609e..8f088c5c 100644 --- a/functions/index.multiaddr-1.html +++ b/functions/index.multiaddr-1.html @@ -2,4 +2,4 @@

    Parameters

    Returns Multiaddr

    Example

    import { multiaddr } from '@libp2p/multiaddr'

    multiaddr('/ip4/127.0.0.1/tcp/4001')
    // Multiaddr(/ip4/127.0.0.1/tcp/4001)
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.protocols.html b/functions/index.protocols.html index 94e074b4..f092aebf 100644 --- a/functions/index.protocols.html +++ b/functions/index.protocols.html @@ -1,4 +1,4 @@ protocols | @multiformats/multiaddr

    Function protocols

    • protocols(proto): Protocol

    • For the passed proto string or number, return a Protocol

      Parameters

      • proto: string | number

      Returns Protocol

      Example

      import { protocol } from '@multiformats/multiaddr'

      console.info(protocol(4))
      // { code: 4, size: 32, name: 'ip4', resolvable: false, path: false }
      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/resolvers.dnsaddrResolver.html b/functions/resolvers.dnsaddrResolver.html index 7565b6b9..4217eeed 100644 --- a/functions/resolvers.dnsaddrResolver.html +++ b/functions/resolvers.dnsaddrResolver.html @@ -1,4 +1,4 @@ dnsaddrResolver | @multiformats/multiaddr

    Function dnsaddrResolver

    • dnsaddrResolver(addr, options?): Promise<string[]>

    • Resolver for dnsaddr addresses.

      Parameters

      Returns Promise<string[]>

      Example

      import { dnsaddrResolver } from '@multiformats/multiaddr/resolvers'
      import { multiaddr } from '@multiformats/multiaddr'

      const ma = multiaddr('/dnsaddr/bootstrap.libp2p.io')
      const addresses = await dnsaddrResolver(ma)

      console.info(addresses)
      //[
      //  '/dnsaddr/am6.bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb',
      //  '/dnsaddr/ny5.bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa',
      //  '/dnsaddr/sg1.bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt',
      //  '/dnsaddr/sv15.bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN'
      //]
      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.AbortOptions.html b/interfaces/index.AbortOptions.html index 607a3e22..096d5082 100644 --- a/interfaces/index.AbortOptions.html +++ b/interfaces/index.AbortOptions.html @@ -1,3 +1,3 @@ AbortOptions | @multiformats/multiaddr

    Interface AbortOptions

    Allows aborting long-lived operations

    -
    interface AbortOptions {
        signal?: AbortSignal;
    }

    Properties

    signal? -

    Properties

    Optional signal

    signal?: AbortSignal

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
    interface AbortOptions {
        signal?: AbortSignal;
    }

    Properties

    signal? +

    Properties

    Optional signal

    signal?: AbortSignal

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.Multiaddr.html b/interfaces/index.Multiaddr.html index a3e40db6..5ae35c7e 100644 --- a/interfaces/index.Multiaddr.html +++ b/interfaces/index.Multiaddr.html @@ -1,4 +1,4 @@ -Multiaddr | @multiformats/multiaddr

    Interface Multiaddr

    interface Multiaddr {
        bytes: Uint8Array;
        decapsulate(addr): Multiaddr;
        decapsulateCode(code): Multiaddr;
        encapsulate(addr): Multiaddr;
        equals(addr): boolean;
        getPath(): null | string;
        getPeerId(): null | string;
        isThinWaistAddress(addr?): boolean;
        nodeAddress(): NodeAddress;
        protoCodes(): number[];
        protoNames(): string[];
        protos(): Protocol[];
        resolve(options?): Promise<Multiaddr[]>;
        stringTuples(): StringTuple[];
        toJSON(): string;
        toOptions(): MultiaddrObject;
        toString(): string;
        tuples(): Tuple[];
    }

    Properties

    bytes +Multiaddr | @multiformats/multiaddr

    Interface Multiaddr

    interface Multiaddr {
        bytes: Uint8Array;
        decapsulate(addr): Multiaddr;
        decapsulateCode(code): Multiaddr;
        encapsulate(addr): Multiaddr;
        equals(addr): boolean;
        getPath(): null | string;
        getPeerId(): null | string;
        isThinWaistAddress(addr?): boolean;
        nodeAddress(): NodeAddress;
        protoCodes(): number[];
        protoNames(): string[];
        protos(): Protocol[];
        resolve(options?): Promise<Multiaddr[]>;
        stringTuples(): StringTuple[];
        toJSON(): string;
        toOptions(): MultiaddrObject;
        toString(): string;
        tuples(): Tuple[];
    }

    Properties

    bytes

    Methods

    decapsulate decapsulateCode encapsulate @@ -16,74 +16,74 @@ toOptions toString tuples -

    Properties

    bytes

    bytes: Uint8Array

    Methods

    decapsulate

    • decapsulate(addr): Multiaddr

    • Decapsulates a Multiaddr from another Multiaddr

      +

    Properties

    bytes

    bytes: Uint8Array

    Methods

    decapsulate

    • decapsulate(addr): Multiaddr

    • Decapsulates a Multiaddr from another Multiaddr

      Parameters

      • addr: string | Multiaddr

        Multiaddr to remove from this Multiaddr

      Returns Multiaddr

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      const mh1 = multiaddr('/ip4/8.8.8.8/tcp/1080')
      // Multiaddr(/ip4/8.8.8.8/tcp/1080)

      const mh2 = multiaddr('/ip4/127.0.0.1/tcp/4001')
      // Multiaddr(/ip4/127.0.0.1/tcp/4001)

      const mh3 = mh1.encapsulate(mh2)
      // Multiaddr(/ip4/8.8.8.8/tcp/1080/ip4/127.0.0.1/tcp/4001)

      mh3.decapsulate(mh2).toString()
      // '/ip4/8.8.8.8/tcp/1080'
      -

    decapsulateCode

    • decapsulateCode(code): Multiaddr

    • A more reliable version of decapsulate if you are targeting a +

    decapsulateCode

    • decapsulateCode(code): Multiaddr

    • A more reliable version of decapsulate if you are targeting a specific code, such as 421 (the p2p protocol code). The last index of the code will be removed from the Multiaddr, and a new instance will be returned. If the code is not present, the original Multiaddr is returned.

      Parameters

      • code: number

      Returns Multiaddr

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      const addr = multiaddr('/ip4/0.0.0.0/tcp/8080/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC')
      // Multiaddr(/ip4/0.0.0.0/tcp/8080/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC)

      addr.decapsulateCode(421).toString()
      // '/ip4/0.0.0.0/tcp/8080'

      multiaddr('/ip4/127.0.0.1/tcp/8080').decapsulateCode(421).toString()
      // '/ip4/127.0.0.1/tcp/8080'
      -

    encapsulate

    encapsulate

    • encapsulate(addr): Multiaddr

    • Encapsulates a Multiaddr in another Multiaddr

      Parameters

      Returns Multiaddr

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      const mh1 = multiaddr('/ip4/8.8.8.8/tcp/1080')
      // Multiaddr(/ip4/8.8.8.8/tcp/1080)

      const mh2 = multiaddr('/ip4/127.0.0.1/tcp/4001')
      // Multiaddr(/ip4/127.0.0.1/tcp/4001)

      const mh3 = mh1.encapsulate(mh2)
      // Multiaddr(/ip4/8.8.8.8/tcp/1080/ip4/127.0.0.1/tcp/4001)

      mh3.toString()
      // '/ip4/8.8.8.8/tcp/1080/ip4/127.0.0.1/tcp/4001'
      -

    equals

    • equals(addr): boolean

    • Checks if two Multiaddrs are the same

      +

    equals

    • equals(addr): boolean

    • Checks if two Multiaddrs are the same

      Parameters

      Returns boolean

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      const mh1 = multiaddr('/ip4/8.8.8.8/tcp/1080')
      // Multiaddr(/ip4/8.8.8.8/tcp/1080)

      const mh2 = multiaddr('/ip4/127.0.0.1/tcp/4001')
      // Multiaddr(/ip4/127.0.0.1/tcp/4001)

      mh1.equals(mh1)
      // true

      mh1.equals(mh2)
      // false
      -

    getPath

    • getPath(): null | string

    • Extract the path if the multiaddr contains one

      +

    getPath

    • getPath(): null | string

    • Extract the path if the multiaddr contains one

      Returns null | string

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      const mh1 = multiaddr('/ip4/8.8.8.8/tcp/1080/unix/tmp/p2p.sock')
      // Multiaddr(/ip4/8.8.8.8/tcp/1080/unix/tmp/p2p.sock)

      // should return utf8 string or null if the id is missing or invalid
      const path = mh1.getPath()
      -

    getPeerId

    • getPeerId(): null | string

    • Extract the peerId if the multiaddr contains one

      +

    getPeerId

    • getPeerId(): null | string

    • Extract the peerId if the multiaddr contains one

      Returns null | string

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      const mh1 = multiaddr('/ip4/8.8.8.8/tcp/1080/ipfs/QmValidBase58string')
      // Multiaddr(/ip4/8.8.8.8/tcp/1080/ipfs/QmValidBase58string)

      // should return QmValidBase58string or null if the id is missing or invalid
      const peerId = mh1.getPeerId()
      -

    isThinWaistAddress

    • isThinWaistAddress(addr?): boolean

    • Returns if a Multiaddr is a Thin Waist address or not.

      +

    isThinWaistAddress

    • isThinWaistAddress(addr?): boolean

    • Returns if a Multiaddr is a Thin Waist address or not.

      Thin Waist is if a Multiaddr adheres to the standard combination of:

      {IPv4, IPv6}/{TCP, UDP}

      Parameters

      Returns boolean

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      const mh1 = multiaddr('/ip4/127.0.0.1/tcp/4001')
      // Multiaddr(/ip4/127.0.0.1/tcp/4001)
      const mh2 = multiaddr('/ip4/192.168.2.1/tcp/5001')
      // Multiaddr(/ip4/192.168.2.1/tcp/5001)
      const mh3 = mh1.encapsulate(mh2)
      // Multiaddr(/ip4/127.0.0.1/tcp/4001/ip4/192.168.2.1/tcp/5001)
      const mh4 = multiaddr('/ip4/127.0.0.1/tcp/2000/wss/p2p-webrtc-star/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSooo2a')
      // Multiaddr(/ip4/127.0.0.1/tcp/2000/wss/p2p-webrtc-star/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSooo2a)
      mh1.isThinWaistAddress()
      // true
      mh2.isThinWaistAddress()
      // true
      mh3.isThinWaistAddress()
      // false
      mh4.isThinWaistAddress()
      // false
      -

    nodeAddress

    • nodeAddress(): NodeAddress

    • Gets a Multiaddrs node-friendly address object. Note that protocol information +

    nodeAddress

    • nodeAddress(): NodeAddress

    • Gets a Multiaddrs node-friendly address object. Note that protocol information is left out: in Node (and most network systems) the protocol is unknowable given only the address.

      Has to be a ThinWaist Address, otherwise throws error

      Returns NodeAddress

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      multiaddr('/ip4/127.0.0.1/tcp/4001').nodeAddress()
      // {family: 4, address: '127.0.0.1', port: 4001}
      -

    protoCodes

    • protoCodes(): number[]

    • Returns the codes of the protocols in left-to-right order. +

    protoCodes

    • protoCodes(): number[]

    • Returns the codes of the protocols in left-to-right order. See list of protocols

      Returns number[]

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      multiaddr('/ip4/127.0.0.1/tcp/4001').protoCodes()
      // [ 4, 6 ]
      -

    protoNames

    • protoNames(): string[]

    • Returns the names of the protocols in left-to-right order. +

    protoNames

    • protoNames(): string[]

    • Returns the names of the protocols in left-to-right order. See list of protocols

      Returns string[]

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      multiaddr('/ip4/127.0.0.1/tcp/4001').protoNames()
      // [ 'ip4', 'tcp' ]
      -

    protos

    • protos(): Protocol[]

    • Returns the protocols the Multiaddr is defined with, as an array of objects, in +

    protos

    • protos(): Protocol[]

    • Returns the protocols the Multiaddr is defined with, as an array of objects, in left-to-right order. Each object contains the protocol code, protocol name, and the size of its address space in bits. See list of protocols

      Returns Protocol[]

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      multiaddr('/ip4/127.0.0.1/tcp/4001').protos()
      // [ { code: 4, size: 32, name: 'ip4' },
      //   { code: 6, size: 16, name: 'tcp' } ]
      -

    resolve

    resolve

    • resolve(options?): Promise<Multiaddr[]>

    • Resolve multiaddr if containing resolvable hostname.

      Parameters

      Returns Promise<Multiaddr[]>

      Example

      import { multiaddr, resolvers } from '@multiformats/multiaddr'

      resolvers.set('dnsaddr', resolverFunction)
      const mh1 = multiaddr('/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb')
      const resolvedMultiaddrs = await mh1.resolve()
      // [
      //   Multiaddr(/ip4/147.75.83.83/tcp/4001/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb),
      //   Multiaddr(/ip4/147.75.83.83/tcp/443/wss/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb),
      //   Multiaddr(/ip4/147.75.83.83/udp/4001/quic/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb)
      // ]
      -

    stringTuples

    stringTuples

    • stringTuples(): StringTuple[]

    • Returns a tuple of string/number parts

      • tuples[][0] = code of protocol
      • tuples[][1] = contents of address

      Returns StringTuple[]

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      multiaddr('/ip4/127.0.0.1/tcp/4001').stringTuples()
      // [ [ 4, '127.0.0.1' ], [ 6, '4001' ] ]
      -

    toJSON

    • toJSON(): string

    • Returns Multiaddr as a JSON encoded object

      +

    toJSON

    • toJSON(): string

    • Returns Multiaddr as a JSON encoded object

      Returns string

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      JSON.stringify(multiaddr('/ip4/127.0.0.1/tcp/4001'))
      // '/ip4/127.0.0.1/tcp/4001'
      -

    toOptions

    • toOptions(): MultiaddrObject

    • Returns Multiaddr as a convinient options object to be used with net.createConnection

      +

    toOptions

    • toOptions(): MultiaddrObject

    • Returns Multiaddr as a convinient options object to be used with net.createConnection

      Returns MultiaddrObject

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      multiaddr('/ip4/127.0.0.1/tcp/4001').toOptions()
      // { family: 4, host: '127.0.0.1', transport: 'tcp', port: 4001 }
      -

    toString

    • toString(): string

    • Returns Multiaddr as a String

      +

    toString

    • toString(): string

    • Returns Multiaddr as a String

      Returns string

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      multiaddr('/ip4/127.0.0.1/tcp/4001').toString()
      // '/ip4/127.0.0.1/tcp/4001'
      -

    tuples

    tuples

    • tuples(): Tuple[]

    • Returns a tuple of parts

      Returns Tuple[]

      Example

      import { multiaddr } from '@multiformats/multiaddr'

      multiaddr('/ip4/127.0.0.1/tcp/4001').tuples()
      // [ [ 4, <Buffer 7f 00 00 01> ], [ 6, <Buffer 0f a1> ] ]
      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.MultiaddrObject.html b/interfaces/index.MultiaddrObject.html index ef655cef..c4b6bfa2 100644 --- a/interfaces/index.MultiaddrObject.html +++ b/interfaces/index.MultiaddrObject.html @@ -1,6 +1,6 @@ MultiaddrObject | @multiformats/multiaddr

    Interface MultiaddrObject

    A plain JavaScript object representation of a Multiaddr

    -
    interface MultiaddrObject {
        family: 4 | 6;
        host: string;
        port: number;
        transport: string;
    }

    Properties

    family +
    interface MultiaddrObject {
        family: 4 | 6;
        host: string;
        port: number;
        transport: string;
    }

    Properties

    family host port transport -

    Properties

    family

    family: 4 | 6

    host

    host: string

    port

    port: number

    transport

    transport: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    family

    family: 4 | 6

    host

    host: string

    port

    port: number

    transport

    transport: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.NodeAddress.html b/interfaces/index.NodeAddress.html index 806f0d0e..0c5b6462 100644 --- a/interfaces/index.NodeAddress.html +++ b/interfaces/index.NodeAddress.html @@ -1,5 +1,5 @@ NodeAddress | @multiformats/multiaddr

    Interface NodeAddress

    A NodeAddress is an IPv4/IPv6 address/TCP port combination

    -
    interface NodeAddress {
        address: string;
        family: 4 | 6;
        port: number;
    }

    Properties

    address +
    interface NodeAddress {
        address: string;
        family: 4 | 6;
        port: number;
    }

    Properties

    address family port -

    Properties

    address

    address: string

    family

    family: 4 | 6

    port

    port: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    address

    address: string

    family

    family: 4 | 6

    port

    port: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.Protocol.html b/interfaces/index.Protocol.html index df01811f..7c3646aa 100644 --- a/interfaces/index.Protocol.html +++ b/interfaces/index.Protocol.html @@ -1,7 +1,7 @@ Protocol | @multiformats/multiaddr

    Interface Protocol

    Protocols are present in the protocol table

    -
    interface Protocol {
        code: number;
        name: string;
        path?: boolean;
        resolvable?: boolean;
        size: number;
    }

    Properties

    code +
    interface Protocol {
        code: number;
        name: string;
        path?: boolean;
        resolvable?: boolean;
        size: number;
    }

    Properties

    code name path? resolvable? size -

    Properties

    code

    code: number

    name

    name: string

    Optional path

    path?: boolean

    Optional resolvable

    resolvable?: boolean

    size

    size: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    code

    code: number

    name

    name: string

    Optional path

    path?: boolean

    Optional resolvable

    resolvable?: boolean

    size

    size: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.Resolver.html b/interfaces/index.Resolver.html index 19b8c48e..4bd21867 100644 --- a/interfaces/index.Resolver.html +++ b/interfaces/index.Resolver.html @@ -1,3 +1,3 @@ Resolver | @multiformats/multiaddr

    Interface Resolver

    A Resolver is a function that takes a Multiaddr and resolves it into one or more string representations of that Multiaddr.

    -
    interface Resolver ((addr, options?) => Promise<string[]>)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
    interface Resolver ((addr, options?) => Promise<string[]>)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/convert.html b/modules/convert.html index 17b20b84..bb02d01c 100644 --- a/modules/convert.html +++ b/modules/convert.html @@ -1,5 +1,5 @@ convert | @multiformats/multiaddr

    Module convert

    Provides methods for converting

    -

    Index

    Functions

    convert +

    Index

    Functions

    convert convertToBytes convertToIpNet convertToString diff --git a/modules/index.html b/modules/index.html index 2302fbd7..aac53db3 100644 --- a/modules/index.html +++ b/modules/index.html @@ -28,7 +28,7 @@

    A resolver receives a Multiaddr as a parameter and returns a Promise<Array<string>>.

    -

    Index

    Classes

    MultiaddrFilter +

    Index

    Classes

    MultiaddrFilter

    Interfaces

    AbortOptions Multiaddr MultiaddrObject diff --git a/modules/resolvers.html b/modules/resolvers.html index b43dbe15..edc801ee 100644 --- a/modules/resolvers.html +++ b/modules/resolvers.html @@ -1,3 +1,3 @@ resolvers | @multiformats/multiaddr

    Module resolvers

    Provides strategies for resolving multiaddrs.

    -

    Index

    Functions

    dnsaddrResolver +

    Index

    Functions

    dnsaddrResolver

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.MultiaddrInput.html b/types/index.MultiaddrInput.html index 9903e3d7..8d69747c 100644 --- a/types/index.MultiaddrInput.html +++ b/types/index.MultiaddrInput.html @@ -1,2 +1,2 @@ MultiaddrInput | @multiformats/multiaddr

    Type alias MultiaddrInput

    MultiaddrInput: string | Multiaddr | Uint8Array | null

    These types can be parsed into a Multiaddr object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.StringTuple.html b/types/index.StringTuple.html index 4e960fe0..cb3182ed 100644 --- a/types/index.StringTuple.html +++ b/types/index.StringTuple.html @@ -1,2 +1,2 @@ StringTuple | @multiformats/multiaddr

    Type alias StringTuple

    StringTuple: [number, string?]

    A code/value pair with the value as a string

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.Tuple.html b/types/index.Tuple.html index f12a0bca..74530aca 100644 --- a/types/index.Tuple.html +++ b/types/index.Tuple.html @@ -1,2 +1,2 @@ Tuple | @multiformats/multiaddr

    Type alias Tuple

    Tuple: [number, Uint8Array?]

    A code/value pair

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/index.resolvers.html b/variables/index.resolvers.html index 8151e84c..6972f545 100644 --- a/variables/index.resolvers.html +++ b/variables/index.resolvers.html @@ -1,2 +1,2 @@ resolvers | @multiformats/multiaddr

    Variable resolversConst

    resolvers: Map<string, Resolver> = ...

    All configured Resolvers

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file