Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EdgesTCP

Hierarchy

  • EdgesTCP

Index

Constructors

Methods

Constructors

constructor

  • new EdgesTCP(httpClient: Wretcher): EdgesTCP

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

    Parameters

    • httpClient: Wretcher

    Returns EdgesTCP

Methods

create

delete

  • delete(id: any): Promise<void>

  • Delete a TCP Edge by ID

    Parameters

    • id: any

    Returns Promise<void>

get

list

  • list(beforeId?: string, limit?: string): Promise<TCPEdge[]>

  • Returns a list of all TCP Edges on this account

    Parameters

    • Optional beforeId: string
    • Optional limit: string

    Returns Promise<TCPEdge[]>

update

  • Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

    Parameters

    Returns Promise<TCPEdge>

Generated using TypeDoc