Skip to main content

requirementPlan

@codebolt/codeboltjs

Variable: requirementPlan

const requirementPlan: {
  addSection: (filePath: string, section: Omit<RequirementPlanSection, "id" | "order">, afterIndex?: number) => Promise<RequirementPlanSectionResponse>;
  create: (fileName: string) => Promise<RequirementPlanCreateResponse>;
  get: (filePath: string) => Promise<RequirementPlanGetResponse>;
  list: () => Promise<RequirementPlanListResponse>;
  removeSection: (filePath: string, sectionId: string) => Promise<RequirementPlanSectionResponse>;
  reorderSections: (filePath: string, sectionIds: string[]) => Promise<RequirementPlanSectionResponse>;
  review: (filePath: string) => Promise<RequirementPlanReviewResponse>;
  update: (filePath: string, content: 
     | string
    | RequirementPlanDocument) => Promise<RequirementPlanUpdateResponse>;
  updateSection: (filePath: string, sectionId: string, updates: Partial<RequirementPlanSection>) => Promise<RequirementPlanSectionResponse>;
};

Defined in: packages/codeboltjs/src/modules/requirementPlan.ts:114

RequirementPlan Module Provides functionality for managing Requirement Plan documents

Type Declaration​

NameTypeDescriptionDefined in
addSection()(filePath: string, section: Omit<RequirementPlanSection, "id" | "order">, afterIndex?: number) => Promise<RequirementPlanSectionResponse>Add a section to a requirement planpackages/codeboltjs/src/modules/requirementPlan.ts:195
create()(fileName: string) => Promise<RequirementPlanCreateResponse>Create a new requirement plan filepackages/codeboltjs/src/modules/requirementPlan.ts:120
get()(filePath: string) => Promise<RequirementPlanGetResponse>Get a requirement plan by file pathpackages/codeboltjs/src/modules/requirementPlan.ts:138
list()() => Promise<RequirementPlanListResponse>List all requirement plans in the projectpackages/codeboltjs/src/modules/requirementPlan.ts:175
removeSection()(filePath: string, sectionId: string) => Promise<RequirementPlanSectionResponse>Remove a section from a requirement planpackages/codeboltjs/src/modules/requirementPlan.ts:242
reorderSections()(filePath: string, sectionIds: string[]) => Promise<RequirementPlanSectionResponse>Reorder sections in a requirement planpackages/codeboltjs/src/modules/requirementPlan.ts:261
review()(filePath: string) => Promise<RequirementPlanReviewResponse>Request a review for a requirement planpackages/codeboltjs/src/modules/requirementPlan.ts:279
update()(filePath: string, content: | string | RequirementPlanDocument) => Promise<RequirementPlanUpdateResponse>Update a requirement planpackages/codeboltjs/src/modules/requirementPlan.ts:157
updateSection()(filePath: string, sectionId: string, updates: Partial<RequirementPlanSection>) => Promise<RequirementPlanSectionResponse>Update a section in a requirement planpackages/codeboltjs/src/modules/requirementPlan.ts:219