Configuration

Global configuration is performed by calling methods on the Files object.

Configuration Options

Base URL

Set this to the full https:// URL of your Files.com subdomain (e.g. https://MY-SUBDOMAIN.files.com). This is not required in most cases, but one benefit of setting it is that it ensures that authentication failures will be logged to your site's API logs. Without setting this, we won't know which site to associate the authentication failure with, and it won't be logged to your site's API logs. This is always required if your site is configured to disable global acceleration. This can also be set to use a mock server in development or CI.

Example setting

import Files from 'files.com/lib/Files';

Files.setBaseUrl("https://MY-SUBDOMAIN.files.com");

Log Level

Supported values:

  • LogLevel.NONE
  • LogLevel.ERROR
  • LogLevel.WARN
  • LogLevel.INFO (default)
  • LogLevel.DEBUG

Example setting

import Files from 'files.com/lib/Files';
import { LogLevel } from 'files.com/lib/Logger';

Files.setLogLevel(LogLevel.INFO);

Debugging

Enable debug logging of API requests and/or response headers. Both settings default to false.

Example setting

import Files from 'files.com/lib/Files';

Files.configureDebugging({
  debugRequest: true,
  debugResponseHeaders: true,
});

Network Settings

Example setting

import Files from 'files.com/lib/Files';

Files.configureNetwork({
  // max retries (default: 3)
  maxNetworkRetries: 3,

  // minimum delay in seconds before retrying (default: 0.5)
  minNetworkRetryDelay: 0.5,

  // max delay in seconds before retrying (default: 1.5)
  maxNetworkRetryDelay: 1.5,

  // network timeout in seconds (default: 30.0)
  networkTimeout: 30.0,

  // auto-fetch all pages when results span multiple pages (default: `true`)
  autoPaginate: true,
});