Variable recipes`Const`

recipes: {
    describe: (title: string) => string | undefined;
    find: (query: string) => RecipeEntry[];
    forAI: () => RecipeEntry[];
    forCapability: (capability: string) => RecipeEntry[];
    forDomain: (domain: string) => RecipeEntry[];
    forProcess: (process: string) => RecipeEntry[];
    getCategories: () => string[];
    getSteps: (title: string) => string | undefined;
    getTopRecipes: (n: number) => RecipeEntry[];
    has: (title: string) => boolean;
    list: () => RecipeEntry[];
    registry: RecipeRegistry;
    search: (query: string) => RecipeEntry[];
    select: (
        filter: {
            category?: string;
            priority?: RecipePriority;
            role?: RecipeRole;
        },
    ) => RecipeEntry[];
    selectByCategory: (category: string) => RecipeEntry[];
    selectByPriority: (priority: RecipePriority) => RecipeEntry[];
    selectByRole: (role: RecipeRole) => RecipeEntry[];
    toJSON: () => readonly RecipeEntry[];
    validate: (title: string) => { role?: RecipeRole; valid: boolean };
} = ...

Consumer-facing recipes introspection API.

Type Declaration

Readonlydescribe: (title: string) => string | undefined
Returns a human-readable description of a named recipe.
Readonlyfind: (query: string) => RecipeEntry[]
Searches recipes by substring match on title, description, or tags.
ReadonlyforAI: () => RecipeEntry[]
Returns all recipes in an AI-agent-friendly format.
ReadonlyforCapability: (capability: string) => RecipeEntry[]
Returns recipes associated with a specific capability.
ReadonlyforDomain: (domain: string) => RecipeEntry[]
Returns recipes relevant to a specific SAP domain.
ReadonlyforProcess: (process: string) => RecipeEntry[]
Returns recipes for a specific business process.
ReadonlygetCategories: () => string[]
Returns unique category names across all registered recipes.
ReadonlygetSteps: (title: string) => string | undefined
Returns the code steps for a named recipe, or undefined.
ReadonlygetTopRecipes: (n: number) => RecipeEntry[]
Returns the top n recipes by insertion order.
Readonlyhas: (title: string) => boolean
Returns true if a recipe with the given title exists.
Readonlylist: () => RecipeEntry[]
Returns all registered recipe entries.
registry: RecipeRegistry
The underlying registry instance (for advanced usage like fromEntries()).
Readonlysearch: (query: string) => RecipeEntry[]
Searches recipes by substring match on title, description, or tags.
Readonlyselect: (
    filter: {
        category?: string;
        priority?: RecipePriority;
        role?: RecipeRole;
    },
) => RecipeEntry[]
Returns recipes matching the given filter criteria.
ReadonlyselectByCategory: (category: string) => RecipeEntry[]
Returns recipes matching the given category.
ReadonlyselectByPriority: (priority: RecipePriority) => RecipeEntry[]
Returns recipes matching the given priority level.
ReadonlyselectByRole: (role: RecipeRole) => RecipeEntry[]
Returns recipes matching the given role.
ReadonlytoJSON: () => readonly RecipeEntry[]
Exports all recipes as a JSON-serializable array.
Readonlyvalidate: (title: string) => { role?: RecipeRole; valid: boolean }
Validates that a recipe title exists and returns basic info.

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();

Variable recipes`Const`

Type Declaration

`Readonly`describe: (title: string) => string | undefined

`Readonly`find: (query: string) => RecipeEntry[]

`Readonly`forAI: () => RecipeEntry[]

`Readonly`forCapability: (capability: string) => RecipeEntry[]

`Readonly`forDomain: (domain: string) => RecipeEntry[]

`Readonly`forProcess: (process: string) => RecipeEntry[]

`Readonly`getCategories: () => string[]

`Readonly`getSteps: (title: string) => string | undefined

`Readonly`getTopRecipes: (n: number) => RecipeEntry[]

`Readonly`has: (title: string) => boolean

`Readonly`list: () => RecipeEntry[]

registry: RecipeRegistry

`Readonly`search: (query: string) => RecipeEntry[]

`Readonly`select: (
    filter: {
        category?: string;
        priority?: RecipePriority;
        role?: RecipeRole;
    },
) => RecipeEntry[]

`Readonly`selectByCategory: (category: string) => RecipeEntry[]

`Readonly`selectByPriority: (priority: RecipePriority) => RecipeEntry[]

`Readonly`selectByRole: (role: RecipeRole) => RecipeEntry[]

`Readonly`toJSON: () => readonly RecipeEntry[]

`Readonly`validate: (title: string) => { role?: RecipeRole; valid: boolean }

Intent

Capability

Example

Settings

Variable recipesConst

Type Declaration

Readonlydescribe: (title: string) => string | undefined

Readonlyfind: (query: string) => RecipeEntry[]

ReadonlyforAI: () => RecipeEntry[]

ReadonlyforCapability: (capability: string) => RecipeEntry[]

ReadonlyforDomain: (domain: string) => RecipeEntry[]

ReadonlyforProcess: (process: string) => RecipeEntry[]

ReadonlygetCategories: () => string[]

ReadonlygetSteps: (title: string) => string | undefined

ReadonlygetTopRecipes: (n: number) => RecipeEntry[]

Readonlyhas: (title: string) => boolean

Readonlylist: () => RecipeEntry[]

registry: RecipeRegistry

Readonlysearch: (query: string) => RecipeEntry[]

Readonlyselect: ( filter: { category?: string; priority?: RecipePriority; role?: RecipeRole; },) => RecipeEntry[]

ReadonlyselectByCategory: (category: string) => RecipeEntry[]

ReadonlyselectByPriority: (priority: RecipePriority) => RecipeEntry[]

ReadonlyselectByRole: (role: RecipeRole) => RecipeEntry[]

ReadonlytoJSON: () => readonly RecipeEntry[]

Readonlyvalidate: (title: string) => { role?: RecipeRole; valid: boolean }

Intent

Capability

Example

Settings

Variable recipes`Const`

`Readonly`describe: (title: string) => string | undefined

`Readonly`find: (query: string) => RecipeEntry[]

`Readonly`forAI: () => RecipeEntry[]

`Readonly`forCapability: (capability: string) => RecipeEntry[]

`Readonly`forDomain: (domain: string) => RecipeEntry[]

`Readonly`forProcess: (process: string) => RecipeEntry[]

`Readonly`getCategories: () => string[]

`Readonly`getSteps: (title: string) => string | undefined

`Readonly`getTopRecipes: (n: number) => RecipeEntry[]

`Readonly`has: (title: string) => boolean

`Readonly`list: () => RecipeEntry[]

`Readonly`search: (query: string) => RecipeEntry[]

`Readonly`select: (
filter: {
category?: string;
priority?: RecipePriority;
role?: RecipeRole;
},
) => RecipeEntry[]

`Readonly`selectByCategory: (category: string) => RecipeEntry[]

`Readonly`selectByPriority: (priority: RecipePriority) => RecipeEntry[]

`Readonly`selectByRole: (role: RecipeRole) => RecipeEntry[]

`Readonly`toJSON: () => readonly RecipeEntry[]

`Readonly`validate: (title: string) => { role?: RecipeRole; valid: boolean }