Class HttpListenerBuilder

r" An ngrok listener backing an HTTP endpoint. r" r"

Hierarchy

  • HttpListenerBuilder

Constructors

Methods

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

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

  • OAuth configuration. If not called, OAuth is disabled. See OAuth in the ngrok docs for additional details.

    Parameters

    • provider: string
    • Optional allowEmails: null | string[]
    • Optional allowDomains: null | string[]
    • Optional scopes: null | string[]
    • Optional clientId: null | string
    • Optional clientSecret: null | string

    Returns HttpListenerBuilder

  • OIDC configuration. If not called, OIDC is disabled. See OpenID Connect in the ngrok docs for additional details.

    Parameters

    • issuerUrl: string
    • clientId: string
    • clientSecret: string
    • Optional allowEmails: null | string[]
    • Optional allowDomains: null | string[]
    • Optional scopes: null | string[]

    Returns HttpListenerBuilder

Generated using TypeDoc