Karin API Docs / range

函数: range()

调用签名

range(options): string

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

提取指定版本区间的更新日志

参数

options

RangeOptions

返回

string

调用签名

range(data, startVersion, endVersion, opts?): string

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

提取指定版本区间的更新日志

参数

data

string

CHANGELOG.md 文件内容

startVersion

string

起始版本号（较旧）

endVersion

string

结束版本号（较新）

opts?

CompareMode

版本号对比模式

返回

string

拼接后的更新日志字符串；若任一版本无法定位返回空字符串

Description

• CHANGELOG 的版本排序约定为从新到旧；
• 若传入版本不存在，将回退到不超过目标稳定版的最新版本；
• 当 start > end 时会自动调整为有效区间。

已被弃用

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