@alphabin/trx/dist/types/options.type.d.ts

TRX reporter for Playwright tests with Azure Blob Storage upload support

/**
 * Configuration options for the TRX reporter
 */
export interface TestReportXOptions {
    /**
     * TRX server URL
     */
    serverUrl: string;
    /**
     * API key for authentication
     */
    apiKey: string;
    /**
     * Whether to collect git metadata
     * @default true
     */
    collectGitMetadata?: boolean;
    /**
     * Whether to collect CI/CD metadata
     * @default true
     */
    collectCiMetadata?: boolean;
    /**
     * Whether to collect system metadata
     * @default true
     */
    collectSystemMetadata?: boolean;
    /**
     * Disable HTML report and trace uploads to Azure Blob Storage
     * @default false
     */
    disableUpload?: boolean;
    /**
     * Additional custom metadata to include
     */
    customMetadata?: Record<string, any>;
    /**
     * Directory where test reports are stored
     * @default './test-results'
     */
    reportDir?: string;
    /**
     * Custom tags to include with the test run
     */
    tags?: string[];
    /**
     * Whether to log debug information
     * @default false
     */
    debug?: boolean;
    /**
     * Timeout for API requests in milliseconds
     * @default 30000
     */
    timeout?: number;
    /**
     * Number of retry attempts for API requests
     * @default 3
     */
    retries?: number;
}