Class TlsListenerBuilder

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

Hierarchy

  • TlsListenerBuilder

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 TlsListenerBuilder

  • 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 TlsListenerBuilder

  • Begin listening for new connections on this listener.

    Parameters

    • Optional bind: 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>

Generated using TypeDoc