Skip to main content

Variable: capabilities

const capabilities: object

Defined in: src/ai/capabilities.ts:40

Consumer-facing capabilities introspection API.

Type Declaration​

byCategory()​

readonly byCategory: (category) => CapabilityEntry[]

Returns capabilities matching the given category.

Parameters​

category​

string

Returns​

CapabilityEntry[]

describe()​

readonly describe: (name) => string | undefined

Returns a human-readable description of a named capability.

Parameters​

name​

string

Returns​

string | undefined

find()​

readonly find: (query) => CapabilityEntry[]

Searches capabilities by substring match on name or description.

Parameters​

query​

string

Returns​

CapabilityEntry[]

findByName()​

readonly findByName: (name) => CapabilityEntry | undefined

Returns the first entry matching the given name, or undefined.

Parameters​

name​

string

Returns​

CapabilityEntry | undefined

forAI()​

readonly forAI: () => CapabilitiesJSON

Returns structured JSON optimised for AI agent consumption.

Returns​

CapabilitiesJSON

forControl()​

readonly forControl: (controlType) => CapabilityEntry[]

Returns capabilities relevant to a specific UI5 control type.

Parameters​

controlType​

string

Returns​

CapabilityEntry[]

forProvider()​

readonly forProvider: (provider) => string

Returns capabilities formatted for a specific AI provider.

Parameters​

provider​

"claude" | "openai" | "gemini"

Returns​

string

get()​

readonly get: (id) => CapabilityEntry | undefined

Looks up a capability by its kebab-case ID.

Parameters​

id​

string

Returns​

CapabilityEntry | undefined

getCategories()​

readonly getCategories: () => readonly string[]

Returns unique category names across all registered capabilities.

Returns​

readonly string[]

getStatistics()​

readonly getStatistics: () => CapabilityStats

Returns a statistical summary of the registry.

Returns​

CapabilityStats

has()​

readonly has: (name) => boolean

Returns true if a capability with the given name is registered.

Parameters​

name​

string

Returns​

boolean

list()​

readonly list: () => CapabilityEntry[]

Returns all registered capability entries.

Returns​

CapabilityEntry[]

listByPriority()​

readonly listByPriority: (priority) => CapabilityEntry[]

Returns entries matching the given priority tier.

Parameters​

priority​

"fixture" | "namespace" | "implementation"

Returns​

CapabilityEntry[]

listFixtures()​

readonly listFixtures: () => CapabilityEntry[]

Returns entries with priority === 'fixture' (Playwright best practice).

Returns​

CapabilityEntry[]

registry​

registry: CapabilityRegistry

The underlying registry instance (for advanced usage like register()).

toJSON()​

readonly toJSON: () => CapabilitiesJSON

Exports the full registry as structured JSON.

Returns​

CapabilitiesJSON

Intent​

Provide drop-in parity with mk's capabilities object.

Capability​

Capability discovery, AI context building.

Example​

import { capabilities } from 'playwright-praman';

if (capabilities.has('clickButton')) {
  const cap = capabilities.findByName('clickButton');
}