Interface Ai11yClient

Client interface for interacting with the AI accessibility system

interface Ai11yClient {
    act(instruction: Instruction): void;
    describe(): Ai11yContext;
    reportError(
        error: Error,
        meta?: { markerId?: string; surface?: string },
    ): void;
    track(event: string, payload?: unknown): void;
}

Index

Methods

act describe reportError track

Methods

act

act(instruction: Instruction): void
Executes an instruction on the UI
Parameters
- instruction: Instruction
Returns void
- Defined in client-api.ts:25

describe

describe(): Ai11yContext
Describes the current UI context (markers, route, state, errors)

Returns Ai11yContext
- Defined in client-api.ts:20

reportError

reportError(error: Error, meta?: { markerId?: string; surface?: string }): void
Reports an error to the system
Parameters
- error: Error
- Optionalmeta: { markerId?: string; surface?: string }
Returns void
- Defined in client-api.ts:35

track

track(event: string, payload?: unknown): void
Tracks a custom event
Parameters
- event: string
- Optionalpayload: unknown
Returns void
- Defined in client-api.ts:30