TypeScript API Documentation¶
Auto-generated API documentation for the ACME Portal VS Code Extension
This documentation is automatically generated from the TypeScript source code using TypeDoc. It provides comprehensive reference information for all classes, interfaces, functions, and modules in the extension.
🔄 Regenerating Documentation¶
To regenerate this API documentation after making changes to the TypeScript source code:
# Regenerate API docs only
npm run docs:api
# Regenerate and build complete documentation site
npm run docs:build
📋 Overview¶
The ACME Portal extension is organized into the following modules:
Modules¶
- actions/deploy
- actions/findDeployments
- actions/findFlows
- actions/promote
- commands/CommandManager
- commands/ComparisonCommands
- commands/DeploymentCommands
- commands/FlowCommands
- commands/PromotionCommands
- commands/SettingsCommands
- commands/TreeViewCommands
- extension
- sdk/sdkObjectRunner
- treeView/items/BaseTreeItem
- treeView/items/BranchTreeItem
- treeView/items/DetailTreeItem
- treeView/items/EnvironmentTreeItem
- treeView/items/FlowTreeItem
- treeView/items/GroupTreeItem
- treeView/items/TagTreeItem
- treeView/items/TagsDirectoryTreeItem
- treeView/items
- treeView/searchViewProvider
- treeView/treeDataProvider
- utils/commandExecutor
- utils/errorNotificationService
- utils/gitService
- utils/groupUtils
- utils/preConditionChecker
- utils/pythonScriptExecutor
- utils/searchUtils
- utils/versionUtils
- utils/workspaceService