Class Session

An ngrok session.

Hierarchy

Session

Index

Constructors

Methods

close closeListener httpEndpoint labeledListener listeners tcpEndpoint tlsEndpoint

Constructors

constructor

new Session(): Session
Returns Session

Methods

close

close(): Promise<void>
Close the ngrok session.

Returns Promise<void>
- Defined in index.d.ts:889

closeListener

closeListener(id): Promise<void>
Close a listener with the given ID.
Parameters
- id: string
Returns Promise<void>
- Defined in index.d.ts:887

httpEndpoint

httpEndpoint(): HttpListenerBuilder
Start building a listener backing an HTTP endpoint.

Returns HttpListenerBuilder
- Defined in index.d.ts:877

labeledListener

labeledListener(): LabeledListenerBuilder
Start building a labeled listener.

Returns LabeledListenerBuilder
- Defined in index.d.ts:883

listeners

listeners(): Promise<Listener[]>
Retrieve a list of this session's non-closed listeners, in no particular order.

Returns Promise<Listener[]>
- Defined in index.d.ts:885

tcpEndpoint

tcpEndpoint(): TcpListenerBuilder
Start building a listener backing a TCP endpoint.

Returns TcpListenerBuilder
- Defined in index.d.ts:879

tlsEndpoint

tlsEndpoint(): TlsListenerBuilder
Start building a listener backing a TLS endpoint.

Returns TlsListenerBuilder
- Defined in index.d.ts:881

Generated using TypeDoc