@pumpkin-plugins/upnpumpkin-api API / protocol / PortRequest

Interface: PortRequest

Defined in: tools/upnpumpkin-api/src/protocol.ts:10

A port a plugin wants reachable from the internet.

Properties

description

description: string

Defined in: tools/upnpumpkin-api/src/protocol.ts:19

Shown in the router's list of forwarded ports.

---

externalPort?

optional externalPort?: number

Defined in: tools/upnpumpkin-api/src/protocol.ts:17

The public port to ask for. Defaults to port; the router may give another one.

---

key

key: string

Defined in: tools/upnpumpkin-api/src/protocol.ts:12

Names the request within the asking plugin. UPnPumpkin keeps the plugins' keys apart.

---

port

port: number

Defined in: tools/upnpumpkin-api/src/protocol.ts:15

The port on this machine.