@achingbrain/nat-port-mapper
    Preparing search index...

    Interface UPnPNATOptions

    interface UPnPNATOptions {
        autoRefresh?: boolean;
        description?: string;
        gatewaySearchInterval?: number;
        refreshThreshold?: number;
        refreshTimeout?: number;
        ttl?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoRefresh? description? gatewaySearchInterval? refreshThreshold? refreshTimeout? ttl?

    Properties

    autoRefresh?: boolean

    If true, any mapped ports will be refreshed when their lease expires

    true
    description?: string

    If passed this will be used as the default description when mapping ports

    '@achingbrain/nat-port-mapper'
    gatewaySearchInterval?: number

    When a discovered gateway's TTL expires we will attempt to relocate it on the local network. By default only one SSDP M-SEARCH message will be broadcast at the beginning of the search, pass a ms value here to instead broadcast it on an interval.

    This may be necessary if devices on your network do not always respond to search messages.

    refreshThreshold?: number

    How long before expiry to remap the port mapping in ms

    60_000
    refreshTimeout?: number

    How long to wait while trying to refresh a port mapping in ms

    10_000
    ttl?: number

    TTL for port mappings in ms

    3_600_000

    Settings

    Member Visibility

    On This Page

    Properties