Skip to content

@pumpkin-plugins/port-mapping API / gateway / MappingRequest

Interface: MappingRequest ​

Defined in: tools/port-mapping/src/gateway.ts:11

What to open on the router.

Properties ​

description ​

description: string

Defined in: tools/port-mapping/src/gateway.ts:18

Shown in the router's list of forwarded ports.


externalPort ​

externalPort: number

Defined in: tools/port-mapping/src/gateway.ts:16

The port to ask for on the router's public side. The router may give another one.


internalPort ​

internalPort: number

Defined in: tools/port-mapping/src/gateway.ts:14

The port on this machine.


leaseSeconds ​

leaseSeconds: number

Defined in: tools/port-mapping/src/gateway.ts:20

How long the router keeps the mapping without a renewal. 0 asks for one that doesn't expire.

Pumpkin Plugins documentation