@142vip.changelog.Variable.MarkdownAPI

API 参考 / @142vip/changelog / MarkdownAPI

Variable: MarkdownAPI

const MarkdownAPI: object

Defined in: changelog/src/core/markdown.api.ts:191

Type Declaration

formatSection()

formatSection: (commits, options) => string[]

格式化Section

Parameters

commits

Commit[]

options

baseUrl

string

capitalize

boolean

emoji

boolean

group?

boolean | "multiple"

repo

string

scopeMap

Record<string, string>

scopeName?

string

sectionName

string

Returns

string[]

getGithubVersionDescription()

getGithubVersionDescription: (__namedParameters) => string

Parameters

__namedParameters

baseUrl

string

fromVersion

string

repo

string

toVersion

string

Returns

string

getNoSignificantChanges()

getNoSignificantChanges: () => string

无内容更新

Returns

string

getNPMVersionDescription()

getNPMVersionDescription: (pkgName, pkgVersion) => string

获取npm版本描述

Parameters

pkgName

string

pkgVersion

string

Returns

string