API.md

API Reference

Table of Contents

• Classes
  • Tunnel
• Interfaces
  • OnConnectHandler
• Structs
  • NgrokProps

Tunnel (preflight class)

No description

Constructor

new(url: str, props: NgrokProps?): Tunnel

Properties

Name	Type	Description
url	str	No description

Methods

Signature	Description
onConnect(handler: inflight (str): void): void	No description

OnConnectHandler (interface)

No description

Properties

No properties

Methods

Signature	Description
inflight handle(url: str): void	No description

NgrokProps (struct)

No description

Properties

Name	Type	Description
domain	str?	No description
onConnect	(inflight (str): void)?	No description