@dockcodes/a11y-checker

TypeScript client for Accessibility Checker API.

Installation

npm install @dockcodes/a11y-checker

Usage

import { Client } from "@dockcodes/a11y-checker";

const guest = new Client(); // without key
// const client = new Client({apiKey: "YOUR_API_KEY"});

async function run() {
    const result = await guest.scan({
        url: "https://example.com",
        lang: "en",
        device: "desktop",
        sync: false
    });
    console.log(result);
    
    guest.audit({uuid: result.response.uuid}).then(result => {
        console.log(result)
    })
}

run();

API Methods

| Method | Description | |-----------------------------------------------------------------------------------------------------------|-------------------------------| | scan(params: ScanRequest, options: FetchOptions) => ScanResponse | Run a new accessibility scan | | rescan(params: RescanRequest, options: FetchOptions) => ScanResponse | Rescan an existing audit | | audit(params: AuditRequest, options: FetchOptions) => AuditResponse | Get audit details | | audits(params: AuditsRequest, options: FetchOptions) => AuditsResponse | Get multiple audits | | history(params: HistoryRequest, options: FetchOptions) => HistoryResponse | Get audit history | | deleteAudit(params: DeleteRequest, options: FetchOptions) => DeleteResponse | Delete an audit | | deleteHistory(params: DeleteRequest, options: FetchOptions) => DeleteResponse | Delete an audit's history | | updateAuditManual(params: UpdateAuditManualRequest, options: FetchOptions) => UpdateAuditManualResponse | Update status of manual audit | | user(params: UserRequest, options: FetchOptions) => UserResponse | Get current user info |

Types

FetchOptions

ScanRequest

ScanResponse

RescanRequest

AuditRequest

AuditResponse

AuditsRequest

AuditsResponse

HistoryRequest

HistoryResponse

DeleteRequest

DeleteResponse

DeleteRequest

DeleteResponse

UpdateAuditManualRequest

UpdateAuditManualResponse

UserRequest

UserResponse

🔑 Get Your API Key

You can test as a guest, request an API key, or test the service directly on the website:

👉 https://wcag.dock.codes/contact-us/