Skip to main content
Version: 1.x

Variable: recipes

const recipes: object

Defined in: src/ai/recipes.ts:48

Consumer-facing recipes introspection API.

Type Declaration​

describe()​

readonly describe: (name) => string | undefined

Returns a human-readable description of a named recipe.

Parameters​

name​

string

Returns​

string | undefined

find()​

readonly find: (query) => object[]

Searches recipes by substring match on name or description.

Parameters​

query​

string

Returns​

forAI()​

readonly forAI: () => object[]

Returns all recipes in an AI-agent-friendly format.

Returns​

forCapability()​

readonly forCapability: (capability) => object[]

Returns recipes associated with a specific capability.

Parameters​

capability​

string

Returns​

forDomain()​

readonly forDomain: (domain) => object[]

Returns recipes relevant to a specific SAP domain.

Parameters​

domain​

string

Returns​

forProcess()​

readonly forProcess: (process) => object[]

Returns recipes for a specific business process.

Parameters​

process​

string

Returns​

getDomains()​

readonly getDomains: () => string[]

Returns unique domain names across all registered recipes.

Returns​

string[]

getSteps()​

readonly getSteps: (name) => string | undefined

Returns the pattern code for a named recipe, or undefined.

Parameters​

name​

string

Returns​

string | undefined

getTopRecipes()​

readonly getTopRecipes: (n) => object[]

Returns the top n recipes by insertion order.

Parameters​

n​

number

Returns​

has()​

readonly has: (name) => boolean

Returns true if a recipe with the given name exists.

Parameters​

name​

string

Returns​

boolean

list()​

readonly list: () => object[]

Returns all registered recipe entries.

Returns​

registry​

registry: RecipeRegistry

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

readonly search: (query) => object[]

Searches recipes by substring match on name or description.

Parameters​

query​

string

Returns​

select()​

readonly select: (filter) => object[]

Returns recipes matching the given filter criteria.

Parameters​

filter​
domain?​

string

priority?​

"optional" | "essential" | "recommended" | "advanced" | "deprecated"

Returns​

selectByDomain()​

readonly selectByDomain: (domain) => object[]

Returns recipes matching the given domain.

Parameters​

domain​

string

Returns​

selectByPriority()​

readonly selectByPriority: (priority) => object[]

Returns recipes matching the given priority level.

Parameters​

priority​

"optional" | "essential" | "recommended" | "advanced" | "deprecated"

Returns​

toJSON()​

readonly toJSON: () => readonly object[]

Exports all recipes as a JSON-serializable array.

Returns​

readonly object[]

validate()​

readonly validate: (name) => object

Validates that a recipe name exists.

Parameters​

name​

string

Returns​

object

valid​

readonly valid: boolean

Intent​

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

Capability​

Recipe discovery, AI test scaffolding.

Example​

import { recipes } from 'playwright-praman';

const essential = recipes.selectByPriority('essential');
const all = recipes.forAI();