Class Config

constructor

• new Config(addon: PinggyNative, options?: PinggyOptions): Config

  Creates a new Config instance and initializes it with the provided options.

  Parameters

  • addon: PinggyNative

    The native addon instance.

  • Optionaloptions: PinggyOptions

    The tunnel configuration options.

  Returns Config

getAllowPreflight

• getAllowPreflight(): boolean | null

  Returns boolean | null

getArgument

• getArgument(): string | null

  Gets the current argument string for the tunnel configuration.

  Returns string | null

  The argument string, or null if unavailable.

getAutoReconnect

• getAutoReconnect(): boolean | null

  Returns boolean | null

getBasicAuth

• getBasicAuth(): string[] | null

  Returns string[] | null

getBearerTokenAuth

• getBearerTokenAuth(): string[]

  Returns string[]

getForce

• getForce(): boolean | null

  Gets the current force configuration setting.

  Returns boolean | null

  The force setting, or null if unavailable.

getForwarding

• getForwarding(): string | null

  Gets the forwarding rules configuration. Returns a JSON string containing all forwarding rules configured for this tunnel.

  Returns string | null

  The forwarding rules as a JSON string, or null if unavailable.

  Example

  // Returns something like:
  // [{"type":"http","listenAddress":"","address":"http://localhost:3000"}]
  Copy

getHeaderModification

• getHeaderModification(): string[] | null

  Returns string[] | null

getHttpsOnly

• getHttpsOnly(): boolean | null

  Gets the current HTTPS-only configuration setting.

  Returns boolean | null

  The HTTPS-only setting, or null if unavailable.

getIpWhiteList

• getIpWhiteList(): string[]

  Returns string[]

getLocalServerTls

• getLocalServerTls(): string | null

  Returns string | null

getMaxReconnectAttempts

• getMaxReconnectAttempts(): number | null

  Returns number | null

getNoReverseProxy

• getNoReverseProxy(): boolean | null

  Returns boolean | null

getOriginalRequestUrl

• getOriginalRequestUrl(): boolean | null

  Returns boolean | null

getReconnectInterval

• getReconnectInterval(): number | null

  Returns number | null

getServerAddress

• getServerAddress(): string | null

  Gets the current server address.

  Returns string | null

  The server address, or null if unavailable.

getSniServerName

• getSniServerName(): string | null

  Gets the current SNI server name.

  Returns string | null

  The SNI server name, or null if unavailable.

getToken

• getToken(): string | null

  Gets the current authentication token.

  Returns string | null

  The authentication token, or null if unavailable.

getTunnelSsl

• getTunnelSsl(): boolean | null

  Gets the current SSL configuration for the tunnel.

  Returns boolean | null

  The SSL setting, or null if unavailable.

getWebdebuggerAddr

• getWebdebuggerAddr(): string | null

  Returns string | null

getXForwardedFor

• getXForwardedFor(): boolean | null

  Returns boolean | null

setForce

• setForce(force: boolean): void

  Sets the force configuration for the tunnel. When enabled, forces the tunnel to use specific settings or bypass certain restrictions.

  Parameters

  • force: boolean

    Whether to enable force mode.

  Returns void

setServerAddress

• setServerAddress(address?: string): void

  Sets the server address for the tunnel.

  Parameters

  • Optionaladdress: string = "a.pinggy.io:443"

    The server address.

  Returns void

setToken

• setToken(token: string): void

  Sets the authentication token for the tunnel.

  Parameters

  • token: string

    The authentication token.

  Returns void

configRef