Skip to main content

codeutils

@codebolt/codeboltjs

Variable: codeutils

const codeutils: {
  getAllFilesAsMarkDown: () => Promise<string>;
  getMatcherList: () => Promise<GetMatcherListTreeResponse>;
  matchDetail: (matcher: string) => Promise<getMatchDetail>;
  performMatch: (matcherDefinition: object, problemPatterns: any[], problems: any[]) => Promise<MatchProblemResponse>;
};

Defined in: packages/codeboltjs/src/modules/codeutils.ts:13

A utility module for working with code.

Type Declaration​

NameTypeDescriptionDefined in
getAllFilesAsMarkDown()() => Promise<string>Retrieves all files as Markdown.packages/codeboltjs/src/modules/codeutils.ts:19
getMatcherList()() => Promise<GetMatcherListTreeResponse>Retrieves the list of matchers.packages/codeboltjs/src/modules/codeutils.ts:55
matchDetail()(matcher: string) => Promise<getMatchDetail>Retrieves details of a match.packages/codeboltjs/src/modules/codeutils.ts:70
performMatch()(matcherDefinition: object, problemPatterns: any[], problems: any[]) => Promise<MatchProblemResponse>Performs a matching operation based on the provided matcher definition and problem patterns.packages/codeboltjs/src/modules/codeutils.ts:36