class Ngrok

Defined in:

ngrok.cr
ngrok/downloader.cr
ngrok/version.cr

Constant Summary

Log = ::Log.for("ngrok")
VERSION = "0.3.0"

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(addr : String = "127.0.0.1:3001", subdomain : Nil | String = nil, hostname : Nil | String = nil, timeout : Time::Span = 10.seconds, inspect : Bool = false, region : String = "us", config : Nil | String = nil, use_local_executable : Bool = true, ngrok_bin : String = "./bin") #

[View source]

Class Method Detail

def self.auth(token, use_local_executable = true, bin_path = "./bin") #

[View source]
def self.binary_path(use_local_executable = true, bin_dir = "./bin") #

[View source]
def self.download_ngrok(bin_path) #

[View source]
def self.start(**params) #

[View source]
def self.start(**params, &) #

[View source]

Instance Method Detail

def addr : String #

[View source]
def config : String | Nil #

[View source]
def errored? #

[View source]
def fetch_urls #

[View source]
def finalize #

[View source]
def hostname : String | Nil #

[View source]
def inspect : Bool #
Description copied from class Object

Returns an unambiguous and information-rich string representation of this object, typically intended for developers.

This method should usually not be overridden. It delegates to #inspect(IO) which can be overridden for custom implementations.

Also see #to_s.


[View source]
def ngrok_bin : String #

[View source]
def ngrok_exec_params #

[View source]
def region : String #

[View source]
def running? #

[View source]
def start #

[View source]
def status : Status #

[View source]
def stop #

[View source]
def stopped? #

[View source]
def subdomain : String | Nil #

[View source]
def timeout : Time::Span #

[View source]
def url : String | Nil #

[View source]
def url? : String | Nil | Nil #

[View source]
def url_https : String | Nil #

[View source]
def url_https? : String | Nil | Nil #

[View source]
def use_local_executable : Bool #

[View source]