codemap

@codebolt/codeboltjs

---

Variable: codemap

const codemap: {
  create: (data: CreateCodemapData, projectPath?: string) => Promise<CodemapCreateResponse>;
  delete: (codemapId: string, projectPath?: string) => Promise<CodemapDeleteResponse>;
  get: (codemapId: string, projectPath?: string) => Promise<CodemapGetResponse>;
  list: (projectPath?: string) => Promise<CodemapListResponse>;
  save: (codemapId: string, codemap: Codemap, projectPath?: string) => Promise<CodemapSaveResponse>;
  setStatus: (codemapId: string, status: CodemapStatus, error?: string, projectPath?: string) => Promise<CodemapUpdateResponse>;
  update: (codemapId: string, data: UpdateCodemapData, projectPath?: string) => Promise<CodemapUpdateResponse>;
};

Defined in: packages/codeboltjs/src/modules/codemap.ts:21

Codemap Module for codeboltjs Provides functionality for managing codemaps (visual representations of code structure). Mirrors the codemapService.cli.ts operations via WebSocket.

Type Declaration

Name	Type	Description	Defined in
create()	(data: CreateCodemapData, projectPath?: string) => Promise<CodemapCreateResponse>	Create a placeholder codemap (status: 'creating') Call this before generating the actual codemap content	packages/codeboltjs/src/modules/codemap.ts:58
delete()	(codemapId: string, projectPath?: string) => Promise<CodemapDeleteResponse>	Delete a codemap	packages/codeboltjs/src/modules/codemap.ts:122
get()	(codemapId: string, projectPath?: string) => Promise<CodemapGetResponse>	Get a specific codemap by ID	packages/codeboltjs/src/modules/codemap.ts:41
list()	(projectPath?: string) => Promise<CodemapListResponse>	List all codemaps for a project	packages/codeboltjs/src/modules/codemap.ts:25
save()	(codemapId: string, codemap: Codemap, projectPath?: string) => Promise<CodemapSaveResponse>	Save a complete codemap with content	packages/codeboltjs/src/modules/codemap.ts:74
setStatus()	(codemapId: string, status: CodemapStatus, error?: string, projectPath?: string) => Promise<CodemapUpdateResponse>	Set the status of a codemap	packages/codeboltjs/src/modules/codemap.ts:90
update()	(codemapId: string, data: UpdateCodemapData, projectPath?: string) => Promise<CodemapUpdateResponse>	Update codemap info (title, description, etc.)	packages/codeboltjs/src/modules/codemap.ts:106