Encapsulates the API request configurations.

Constructors

  • Constructs a new ClientConfig instance.

    Parameters

    • params: {
          filePath?: string;
          proxyServerConfig?: ProxyServerConfig;
          region?: Region;
          timeout?: number;
      }

      The parameters for constructing a new ClientConfig instance.

      • Optional filePath?: string

        The path to the file containing the client configuration.

        JSON structure:

        {
          "timeout": "15000",
          "proxyServerConfig": {
            "host": "127.0.0.1",
            "port": "8080",
            "scheme": "https",
            "usernamePasswordCredentials": {
              "username": "username",
              "password": "password"
            }
          },
          "region": "EU"
        }
        
      • Optional proxyServerConfig?: ProxyServerConfig

        A ProxyServerConfig instance for providing proxy server configuration.

      • Optional region?: Region

        A Region instance. Default value is US.

      • Optional timeout?: number

        The timeout for the API request. Default value is 10000 milliseconds.

    Returns ClientConfig

    Remarks

    This documentation indicates that users can specify client configurations such as timeout, region, and proxy settings either directly as parameters or via a configuration file provided using the filePath property. If a configuration is specified in both ways, the settings from the file (specified by filePath) will take precedence.

Properties

_pdfServicesUri: string
_proxyServerConfig?: ProxyServerConfig
_timeout: number
CONNECT_TIMEOUT_KEY: string = "connectTimeout"
PDF_SERVICES: string = "pdf_services"
PDF_SERVICES_URI: string = "pdf_services_uri"
PROXY_CREDENTIALS: string = "usernamePasswordCredentials"
PROXY_HOST: string = "host"
PROXY_PASSWORD: string = "password"
PROXY_PORT: string = "port"
PROXY_SCHEME: string = "proxyScheme"
PROXY_SERVER_CONFIG: string = "proxyServerConfig"
PROXY_USERNAME: string = "username"
REGION: string = "region"

Accessors

  • get pdfServicesUri(): string
  • Internal

    Returns the PDF Services URI. Used internally by this SDK, not intended to be called by clients.

    Returns string

  • get proxyServerConfig(): undefined | ProxyServerConfig
  • Returns the proxy server configuration.

    Returns undefined | ProxyServerConfig

  • get timeout(): number
  • Returns the timeout for the API request.

    Returns number

Methods

  • Parameters

    • clientConfig: {
          [index: string]: any;
      }
      • [index: string]: any

    Returns undefined | ProxyServerConfig

  • Parameters

    • clientConfigFilePath: string

    Returns void

Generated using TypeDoc