libp2p
    Preparing search index...

    Interface UPnPNATClient

    interface UPnPNATClient {
        findGateways(
            options?: FindGatewaysOptions,
        ): AsyncGenerator<Gateway, void, unknown>;
        getGateway(descriptor: URL, options?: AbortOptions): Promise<Gateway>;
    }
    Index

    Methods

    • Search the local network for gateways - when enough gateways have been found, either break out of the for await..of loop or abort a passed AbortSignal.

      Parameters

      Returns AsyncGenerator<Gateway, void, unknown>

    • Use a specific network gateway for port mapping.

      For UPnP this should be a fully qualified URL to a device descriptor XML document, e.g. http://192.168.1.1:4558/rootDesc.xml

      Parameters

      Returns Promise<Gateway>