Options
All
  • Public
  • Public/Protected
  • All
Menu

Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.

Hierarchy

  • ReservedAddrs

Index

Constructors

constructor

  • Do not construct this object directly, use the reservedAddrs property of an Ngrok client object instead.

    Parameters

    • httpClient: Wretcher

    Returns ReservedAddrs

Methods

create

delete

  • delete(arg: Item): Promise<void>
  • Delete a reserved address.

    Parameters

    Returns Promise<void>

deleteEndpointConfig

  • deleteEndpointConfig(arg: Item): Promise<void>
  • Detach the endpoint configuration attached to a reserved address.

    Parameters

    Returns Promise<void>

get

  • Get the details of a reserved address.

    Parameters

    Returns Promise<ReservedAddr>

list

  • List all reserved addresses on this account.

    Returns Promise<ReservedAddr[]>

update

Generated using TypeDoc