semantic-version/src/providers/CommitsProvider.ts
Paul Hatcherian 31f4e3fdf0 Rewrite/refactor for v5, migrate to TypeScript (MAJOR)
Set Jest config file in package script

Include module path

Include tests in project folders

Remove index module exports

Hardcode configuration parameters

Move parameter binding into main run function

Use alias imports

Run test sequentially

Remove cleanup (async conflict)

Revert Jest option

Increase test timeout to 15 seconds
2022-04-03 20:28:28 -04:00

14 lines
491 B
TypeScript

import { CommitInfoSet } from "./CommitInfoSet";
/**
* Defines a provider to retrieve commit information for a range of commits
*/
export interface CommitsProvider {
/**
* Gets the commit information for a range of commits
* @param startHash - The hash of commit of the last release, result should be exclusive
* @param endHash - The hash of the current commit, result should be inclusive
*/
GetCommitsAsync(startHash: string, endHash: string): Promise<CommitInfoSet>;
}