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(): null | boolean

  Returns null | boolean

getArgument

• getArgument(): null | string

  Gets the current argument string for the tunnel configuration.

  Returns null | string

  The argument string, or null if unavailable.

getAutoReconnect

• getAutoReconnect(): null | boolean

  Returns null | boolean

getBasicAuth

• getBasicAuth(): null | string[]

  Returns null | string[]

getBearerTokenAuth

• getBearerTokenAuth(): string[]

  Returns string[]

getForce

• getForce(): null | boolean

  Gets the current force configuration setting.

  Returns null | boolean

  The force setting, or null if unavailable.

getHeaderModification

• getHeaderModification(): null | string[]

  Returns null | string[]

getHttpsOnly

• getHttpsOnly(): null | boolean

  Gets the current HTTPS-only configuration setting.

  Returns null | boolean

  The HTTPS-only setting, or null if unavailable.

getIpWhiteList

• getIpWhiteList(): string[]

  Returns string[]

getLocalServerTls

• getLocalServerTls(): null | string

  Returns null | string

getMaxReconnectAttempts

• getMaxReconnectAttempts(): null | number

  Returns null | number

getNoReverseProxy

• getNoReverseProxy(): null | boolean

  Returns null | boolean

getOriginalRequestUrl

• getOriginalRequestUrl(): null | boolean

  Returns null | boolean

getReconnectInterval

• getReconnectInterval(): null | number

  Returns null | number

getServerAddress

• getServerAddress(): null | string

  Gets the current server address.

  Returns null | string

  The server address, or null if unavailable.

getSniServerName

• getSniServerName(): null | string

  Gets the current SNI server name.

  Returns null | string

  The SNI server name, or null if unavailable.

getTcpForwardTo

• getTcpForwardTo(): null | string

  Gets the current TCP forwarding address.

  Returns null | string

  The TCP forwarding address, or null if unavailable.

getToken

• getToken(): null | string

  Gets the current authentication token.

  Returns null | string

  The authentication token, or null if unavailable.

getTunnelSsl

• getTunnelSsl(): null | boolean

  Gets the current SSL configuration for the tunnel.

  Returns null | boolean

  The SSL setting, or null if unavailable.

getTunnelType

• getTunnelType(): null | string

  Gets the tunnel type.

  Returns null | string

  The tunnel type, or null if unavailable.

getUdpForwardTo

• getUdpForwardTo(): null | string

  Gets the current UDP forwarding address.

  Returns null | string

  The UDP forwarding address, or null if unavailable.

getUdpType

• getUdpType(): null | string

  Gets the tunnel type.

  Returns null | string

  The tunnel type, or null if unavailable.

getXForwardedFor

• getXForwardedFor(): null | boolean

  Returns null | boolean

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