A16nEngine
@a16njs/engine / A16nEngine
Class: A16nEngine
Defined in: index.ts:103
The a16n conversion engine. Orchestrates plugins to discover and emit agent customizations.
Constructors
Constructor
new A16nEngine(
plugins):A16nEngine
Defined in: index.ts:111
Create a new engine with the given plugins.
Parameters
plugins
A16nPlugin[] = []
Plugins to register (registered as 'bundled')
Returns
A16nEngine
Methods
registerPlugin()
registerPlugin(
plugin,source):void
Defined in: index.ts:123
Register a plugin with the engine.
Parameters
plugin
A16nPlugin
The plugin to register
source
Whether the plugin is bundled or installed
"bundled" | "installed"
Returns
void
discoverAndRegisterPlugins()
discoverAndRegisterPlugins(
options?):Promise<DiscoverAndRegisterResult>
Defined in: index.ts:132
Discover and register installed plugins from node_modules.
Parameters
options?
PluginDiscoveryOptions
Plugin discovery options
Returns
Promise<DiscoverAndRegisterResult>
Result with registered, skipped, and error info
listPlugins()
listPlugins():
PluginInfo[]
Defined in: index.ts:155
List all registered plugins.
Returns
Array of plugin info
getPlugin()
getPlugin(
id):A16nPlugin|undefined
Defined in: index.ts:169
Get a plugin by its ID.
Parameters
id
string
The plugin ID
Returns
A16nPlugin | undefined
The plugin or undefined if not found
discover()
discover(
pluginId,rootOrWorkspace):Promise<DiscoveryResult>
Defined in: index.ts:179
Discover customizations using a specific plugin.
Parameters
pluginId
string
The plugin to use for discovery
rootOrWorkspace
The project root path or Workspace to scan
string | Workspace
Returns
Promise<DiscoveryResult>
Discovery result with items and warnings
convert()
convert(
options):Promise<ConversionResult>
Defined in: index.ts:195
Convert customizations from one format to another.
Parameters
options
Conversion options
Returns
Promise<ConversionResult>
Conversion result with discovered items, written files, and warnings