AftTestOptions: Merge<Partial<AftTestConfig>, {
    _cacheResultsToFile?: boolean;
    _preventCacheClear?: boolean;
    aftCfg?: AftConfig;
    buildInfoManager?: BuildInfoManager;
    onEventsMap?: Map<AftTestEvent, AftTestFunction[]>;
    policyManager?: PolicyManager;
    reporter?: ReportingManager;
    testIds?: string[];
}>

Type declaration

  • Optional _cacheResultsToFile?: boolean

    set to true to store each TestResult sent by this AftTest instance to the filesystem

    NOTE

    this should only be set to true by external reporter AftXYZTest instances to prevent double reporting results when the reporter runs

    Default

    false
    
  • Optional _preventCacheClear?: boolean

    set to true to prevent clearing any existing cached results in the constructor on instantiation

    NOTE

    this should only be set to true from within external reporter instances to prevent double reporting results

    Default

    false
    
  • Optional aftCfg?: AftConfig
  • Optional buildInfoManager?: BuildInfoManager
  • Optional onEventsMap?: Map<AftTestEvent, AftTestFunction[]>

    for each type of AftTestEvent you can specify an array of actions to be performed like:

    onEventsMap: new Map<AftTestEvent, Array<AftTestFunction>>([
    ['started', [() => {console.log('started');}]],
    ['pass', [() => {console.log('pass');}]],
    ['fail', [() => {console.log('fail');}]],
    ['skipped', [() => {console.log('skipped');}]]
    ['done', [() => {console.log('done');}]]
    ])

    Default

    new Map<AftTestEvent, Array<AftTestFunction>>()
    
  • Optional policyManager?: PolicyManager
  • Optional reporter?: ReportingManager
  • Optional testIds?: string[]

    an array of test IDs to use if none exist in the description passed to this AftTest constructor

    NOTE

    passing a testIds array will overwrite any pre-existing test IDs parsed from the description

    Default

    new Array<string>()
    

Generated using TypeDoc