@svatah/yam-adapter-atspi

Linux AT-SPI accessibility adapter

• Source: packages/adapter-atspi · README: packages/adapter-atspi/README.md
• Install: npm install @svatah/yam-adapter-atspi
• Version 0.1.0 · Apache-2.0

Exports

Export	Kind	Signature
ACTION_PREFERENCE	variable	ACTION_PREFERENCE: Readonly<Record<string, readonly string[]>>	Which AT-SPI action performs a gesture.
actionFor	function	export function actionFor(kind: string, node: AtspiNode): string | undefined
ATSPI_ADAPTER	variable	ATSPI_ADAPTER = "atspi"
atspiAvailability	function	export async function atspiAvailability(	For a caller that wants to know before it opens one.
AtspiAvailability	interface	export interface AtspiAvailability
AtspiBridge	interface	export interface AtspiBridge	What the adapter needs from Linux. Everything else is a pure function.
AtspiBridgeError	class	export class AtspiBridgeError extends Error
AtspiCommand	typealias	export type AtspiCommand
AtspiNode	interface	export interface AtspiNode	One element of an AT-SPI tree, flattened with parent indices.
AtspiSurface	class	export class AtspiSurface implements AgentSurface
AtspiSurfaceOptions	interface	export interface AtspiSurfaceOptions
AtspiWindow	interface	export interface AtspiWindow
automationIdOf	function	export function automationIdOf(node: AtspiNode): string | undefined	The application's own id for an element (LLD §3.3).
buildNodes	function	export function buildNodes(	Turn a flattened AT-SPI tree into snapshot nodes with stable references.
BuiltNode	interface	export interface BuiltNode
createAtspiSurface	function	export function createAtspiSurface(config: Config): AtspiSurface
isInteractive	function	export function isInteractive(node: AtspiNode): boolean	Whether a node is worth showing when the caller asked for controls only.
nameOf	function	export function nameOf(node: AtspiNode): string	What the element is called, in the order a screen reader would say it.
parseTree	function	export function parseTree(stdout: string): AtspiWindow	Read what the walker wrote.
PERFORM_SCRIPT	variable	PERFORM_SCRIPT = [	Acting, as one program.
pythonBridge	function	export function pythonBridge(options: AtspiBridgeOptions = {}): AtspiBridge	The bridge as it runs on a Linux desktop.
registerAtspiAdapter	function	export function registerAtspiAdapter(): void
roleOf	function	export function roleOf(node: AtspiNode): string	The ARIA role an AT-SPI role name means.
Run	typealias	export type Run = (	Run a program and answer with what it said. Injected, so tests need no bus.
runProcess	variable	runProcess: Run = (command, args, timeoutMs) =>
statesOf	function	export function statesOf(node: AtspiNode): NodeState[]
valueOf	function	export function valueOf(node: AtspiNode): string	The value a read of kind value answers with.
WALK_SCRIPT	variable	WALK_SCRIPT = [	The tree walker, as one Python program.