keep-a-changelog
Version:
Parse and generate changelogs following the [keepachangelog](https://keepachangelog.com/) format.
17 lines (16 loc) • 583 B
TypeScript
import type Changelog from "./Changelog.d.ts";
import type Release from "./Release.d.ts";
export interface Options {
/**
* Custom function to create Release instances.
* Needed if you want to use a custom Release class.
*/
releaseCreator: (version?: string, date?: string, description?: string) => Release;
/**
* If false, releases will not be sorted automatically.
* Default is true.
*/
autoSortReleases: boolean;
}
/** Parse a markdown string */
export default function parser(markdown: string, options?: Partial<Options>): Changelog;