vlt / affordances
  • Quickstart
  • Concepts
  • Guides
  • Reference
  • Overview
    • Overview
    • @affordances/next
    • @affordances/next/codegen
    • @affordances/next/config
    • @affordances/next/manifest
    • @affordances/next/route
    • Reference
  • Classes
  • CodegenError
  • Type Aliases
  • RouteEntry
  • Functions
  • findAppDir()
  • generate()
  • render()
  • scan()
  1. Reference
  2. /
  3. API reference
  4. /
  5. @affordances/next
  6. /
  7. @affordances/next/codegen

@affordances/next/codegen

Classes

CodegenError

Extends

  • Error

Constructors

Constructor
TypeScript
new CodegenError(message?): CodegenError;
Parameters
ParameterType
message?string
Returns

CodegenError

Inherited from

Error.constructor

Constructor
TypeScript
new CodegenError(message?, options?): CodegenError;
Parameters
ParameterType
message?string
options?ErrorOptions
Returns

CodegenError

Inherited from

Error.constructor

Properties

PropertyTypeDefault valueOverrides
namestring'AffordancesCodegenError'Error.name

Type Aliases

RouteEntry

TypeScript
type RouteEntry = object;

Properties

actions?
TypeScript
actions?: object;
NameType
exportsobject[]
filestring
route
TypeScript
route: string;
state?
TypeScript
state?: string;

Functions

findAppDir()

TypeScript
function findAppDir(root): string;

Parameters

ParameterType
rootstring

Returns

string


generate()

TypeScript
function generate(root, options?): RouteEntry[];

Parameters

ParameterType
rootstring
options?{ name?: string; }
options.name?string

Returns

RouteEntry[]


render()

TypeScript
function render(entries, options?): string;

Parameters

ParameterType
entriesRouteEntry[]
options?{ name?: string; }
options.name?string

Returns

string


scan()

TypeScript
function scan(root): RouteEntry[];

Parameters

ParameterType
rootstring

Returns

RouteEntry[]


Previous@affordances/nextNext@affordances/next/config

On this page

  • Classes
  • CodegenError
  • Type Aliases
  • RouteEntry
  • Functions
  • findAppDir()
  • generate()
  • render()
  • scan()

Make your app agent-operable

Give every page a graph and every server action an agent path: HTTP, WebMCP, and MCP, with the same session and the same checks. One command sets it up.

Read the quickstart