Karin API Docs / logs

函数: logs()

调用签名

logs(options): string

定义于: packages/core/src/utils/fs/changelog.ts:31

从指定版本开始提取连续的更新日志

参数

options

LogsOptions

返回

string

调用签名

logs(version, data, length?, reverse?, opts?): string

定义于: packages/core/src/utils/fs/changelog.ts:45

从指定版本开始提取连续的更新日志

参数

version

string

起始版本号

data

string

CHANGELOG.md 文件内容

length?

number

提取条数，默认为 1

reverse?

boolean

是否反向提取；false 向后，true 向前

opts?

CompareMode

版本号对比模式

返回

string

拼接后的更新日志字符串；找不到起始版本返回空字符串

Description

• 起始版本会规范化并回退到不超过目标稳定版的最新版本；
• 切片范围将做边界裁剪以避免越界。

已被弃用

此调用方式将在未来版本废弃，请改用对象参数重载 logs({ ... }) 进行调用