Interface AxeBuilder

Hierarchy

AxeBuilder

Index

Methods

Methods

analyze

analyze(callback?: DeprecatedAnalyzeCallback | AnalyzeCallback): Promise<AxeAnalysis>

- Defined in index.d.ts:80
Perform analysis and retrieve results.

Parameters
- Optional callback: DeprecatedAnalyzeCallback | AnalyzeCallback
  
  Function to execute when analysis completes.
Returns Promise<AxeAnalysis>

configure

configure(config: Spec): AxeBuilder

- Defined in index.d.ts:74
Configures aXe before running analyze.

Parameters
- config: Spec
  
  aXe Configuration spec to use in analysis.
Returns AxeBuilder

disableRules

disableRules(rules: string | string[]): AxeBuilder

- Defined in index.d.ts:67
Set the list of rules to skip when running an analysis

Parameters
- rules: string | string[]
  
  Array of rule IDs, or a single rule ID as a string.
Returns AxeBuilder

exclude

exclude(selector: string): AxeBuilder

- Defined in index.d.ts:35
Excludes a selector from analysis.

Parameters
- selector: string
  
  CSS selector of the element to exclude.
Returns AxeBuilder

include

include(selector: string): AxeBuilder

- Defined in index.d.ts:28
Includes a selector in analysis.

Parameters
- selector: string
  
  CSS selector of the element to include.
Returns AxeBuilder

options

options(options: RunOptions): AxeBuilder

- Defined in index.d.ts:44
Options to directly pass to axe.run.

remarks

Will override any other configured options, including calls to withRules and withTags.

see

https://github.com/dequelabs/axe-core/issues/937

Parameters
- options: RunOptions
  
  aXe options object.
Returns AxeBuilder

withRules

withRules(rules: string | string[]): AxeBuilder

- Defined in index.d.ts:52
Limits analysis to only the specified rules.

remarks

Cannot be used with withTags.

Parameters
- rules: string | string[]
  
  Array of rule IDs, or a single rule ID as a string.
Returns AxeBuilder

withTags

withTags(tags: string | string[]): AxeBuilder

- Defined in index.d.ts:60
Limist analysis to only the specified tags.

remarks

Cannot be used with withRules.

Parameters
- tags: string | string[]
Returns AxeBuilder

Generated using TypeDoc