functional-examplesFUNCTIONAL-EXAMPLES
API/@functional-examples/documentation/FileAccessor

FileAccessor

interface
interface FileAccessor

Chainable accessor returned by file() in both prose and guide contexts.

Supports two usage patterns:

  • <%= file('path.ts') %> — renders the whole file (calls toString())
  • <%= file('path.ts').region('id') %> — renders a scoped region

METHODS

region(regionId: string): string

Render a region within this file as a fenced code block.

toString(): string

Renders the whole file as a fenced code block (called implicitly by Eta's `<%= %>`).