@ngrok/ngrok
    Preparing search index...

    Class TlsListenerBuilder

    r" An ngrok listener backing a TLS endpoint. r" r"

    Index

    Constructors

    Methods

    • Restriction placed on the origin of incoming connections to the edge to only allow these CIDR ranges. Call multiple times to add additional CIDR ranges. See IP restrictions in the ngrok docs for additional details.

      Parameters

      • cidr: string

      Returns this

    • Restriction placed on the origin of incoming connections to the edge to deny these CIDR ranges. Call multiple times to add additional CIDR ranges. See IP restrictions in the ngrok docs for additional details.

      Parameters

      • cidr: string

      Returns this

    • The domain to request for this edge, any valid domain or hostname that you have previously registered with ngrok. If using a custom domain, this requires registering in the ngrok dashboard and setting a DNS CNAME value.

      Parameters

      • domain: string

      Returns this

    • Listener backend metadata. Viewable via the dashboard and API, but has no bearing on listener behavior.

      To automatically forward connections, you can use listenAndForward, or listenAndServe on the Listener Builder. These methods will also set this forwardsTo value.

      Parameters

      • forwardsTo: string

      Returns this

    • Begin listening for new connections on this listener.

      Parameters

      • Optionalbind: null | boolean

      Returns Promise<Listener>

    • Begin listening for new connections on this listener and forwarding them to the given url. This method will also set the forwardsTo value.

      Parameters

      • toUrl: string

      Returns Promise<Listener>

    • Begin listening for new connections on this listener and forwarding them to the given server. This method will also set the forwardsTo value.

      Parameters

      • server: any

      Returns Promise<Listener>

    • Listener-specific opaque metadata. Viewable via the API.

      Parameters

      • metadata: string

      Returns this

    • Certificates to use for client authentication at the ngrok edge. See Mutual TLS in the ngrok docs for additional details.

      Parameters

      • mutualTlsca: Uint8Array

      Returns this

    • Parameters

      • policy: string

      Returns this

    • Enable endpoint pooling for this listener.

      Parameters

      • poolingEnabled: boolean

      Returns this

    • The version of PROXY protocol to use with this listener "1", "2", or "" if not using.

      Parameters

      • proxyProto: string

      Returns this

    • The key to use for TLS termination at the ngrok edge in PEM format. See TLS Termination in the ngrok docs for additional details.

      Parameters

      • certPem: Uint8Array
      • keyPem: Uint8Array

      Returns this

    • Parameters

      • trafficPolicy: string

      Returns this

    • Whether to disable certificate verification for this listener.

      Parameters

      • verifyUpstreamTls: boolean

      Returns this