API 参考
    正在准备搜索索引...

    类 GitCommitAPI

    Git 提交解析与 Markdown 聚合

    索引
    constructor
    getGitCommitDiff parseCommitsToMarkdownStr parseGitCommits
    getGitCommitDiff: (options: GitCommitDiffOptions) => Promise<GitCommitRaw[]> = getGitCommitDiff

    类型声明

    parseCommitsToMarkdownStr: (
        commits: Commit[],
        options: {
            baseUrl: string;
            capitalize: boolean;
            emoji: boolean;
            from: string;
            group?: boolean | "multiple";
            name: string;
            repo: string;
            scopeMap: Record<string, string>;
            scopeName?: string;
            titles: { breakingChanges?: string };
            to: string;
            types: Record<string, { title: string }>;
        },
    ) => Promise<string> = parseCommitsToMarkdownStr

    类型声明

      • (
            commits: Commit[],
            options: {
                baseUrl: string;
                capitalize: boolean;
                emoji: boolean;
                from: string;
                group?: boolean | "multiple";
                name: string;
                repo: string;
                scopeMap: Record<string, string>;
                scopeName?: string;
                titles: { breakingChanges?: string };
                to: string;
                types: Record<string, { title: string }>;
            },
        ): Promise<string>

      • 将提交列表渲染为 CHANGELOG Markdown 正文

        参数

        • commits: Commit[]
        • options: {
              baseUrl: string;
              capitalize: boolean;
              emoji: boolean;
              from: string;
              group?: boolean | "multiple";
              name: string;
              repo: string;
              scopeMap: Record<string, string>;
              scopeName?: string;
              titles: { breakingChanges?: string };
              to: string;
              types: Record<string, { title: string }>;
          }

        返回 Promise<string>

    parseGitCommits: (
        commits: GitCommitRaw[],
        scopeMap: Record<string, string>,
    ) => GitCommitRecord[] = parseGitCommits

    类型声明

    显示设置
    成员可见性

    目录
    构造函数
    属性