Class Configuration

constructor

• new Configuration(server, siteId?, campaigns?, timeout?, maxRetryDelay?, maxAgeOfOldData?, persistEveryNTimes?, serverSideAnonymousUsage?, debug?): Configuration

• Parameters

  • server: string | ConfigurationData

    The server URL should look like https://myhost.example.com/ci/cleaninsights.php.

  • Optional siteId: number

    The Matomo site ID to record this data for. OPTIONAL if provided via an object as first argument.

  • Optional campaigns: {
        [p: string]: Campaign;
    }

    Campaign configuration. OPTIONAL if provided via an object as first argument.

    • [p: string]: Campaign

  • Optional timeout: number

  • Optional maxRetryDelay: number

  • Optional maxAgeOfOldData: number

  • Optional persistEveryNTimes: number

  • Optional serverSideAnonymousUsage: boolean

  • Optional debug: boolean

  Returns Configuration

Readonly campaigns

Readonly debug

Readonly maxAgeOfOldData

Readonly maxRetryDelay

Readonly persistEveryNTimes

Readonly server

Readonly serverSideAnonymousUsage

Readonly siteId

Readonly timeout

check

• check(debug): boolean

• Checks configuration for some well-known problems, emits a debug message and returns false, if one found.

  Parameters

  • debug: ((message) => void)

    Function to handle the debug message.

    • • (message): void

      • Parameters

        • message: string

        Returns void

  Returns boolean

  true, if config seems ok, false if known problems exist.

toString

• toString(): string

• Returns string