@pumpkin-plugins/port-mapping API / testing/fake-igd / FakeIgdOptions

Interface: FakeIgdOptions

Defined in: tools/port-mapping/src/testing/fake-igd.ts:16

How a FakeIgd behaves.

Properties

address?

optional address?: Ipv4

Defined in: tools/port-mapping/src/testing/fake-igd.ts:18

The router's address on the local network.

---

device?

optional device?: object

Defined in: tools/port-mapping/src/testing/fake-igd.ts:34

What the UPnP device description says about the router.

friendlyName?

optional friendlyName?: string

manufacturer?

optional manufacturer?: string

modelName?

optional modelName?: string

modelNumber?

optional modelNumber?: string

---

externalAddress?

optional externalAddress?: Ipv4

Defined in: tools/port-mapping/src/testing/fake-igd.ts:20

The router's address on the internet side.

---

failMappingWith?

optional failMappingWith?: number

Defined in: tools/port-mapping/src/testing/fake-igd.ts:32

Make every AddPortMapping fail with this UPnP error code.

---

httpPort?

optional httpPort?: number

Defined in: tools/port-mapping/src/testing/fake-igd.ts:22

Port of the router's HTTP server.

---

natPmp?

optional natPmp?: boolean

Defined in: tools/port-mapping/src/testing/fake-igd.ts:26

Answer NAT-PMP requests.

---

permanentLeasesOnly?

optional permanentLeasesOnly?: boolean

Defined in: tools/port-mapping/src/testing/fake-igd.ts:28

Refuse mappings that expire, as some routers do.

---

takenPorts?

optional takenPorts?: number[]

Defined in: tools/port-mapping/src/testing/fake-igd.ts:30

External ports that are already in use.

---

upnp?

optional upnp?: boolean

Defined in: tools/port-mapping/src/testing/fake-igd.ts:24

Answer UPnP searches and actions.

---

webPages?

optional webPages?: Record<string, { body: string; status?: number; }>

Defined in: tools/port-mapping/src/testing/fake-igd.ts:36

Pages of the router's web interface on port 80, by path. They are served even when UPnP is off.