UNPKG

1.18 kBTypeScriptView Raw
1/**
2 * A Fingerprint (aka FingerprintData) represents some property of the code in a repository
3 * as of a particular commit.
4 *
5 * It might be the set of dependencies, or the count of tests, or a set of contributors.
6 *
7 * The data here represents a particular fingerprint value. The name, version, and abbreviation
8 * identify the fingerprinted property; data and sha represent the value of that property.
9 * This will be associated with a commit on a repository.
10 */
11export interface Fingerprint {
12 /**
13 * Name of the fingerprint. This should be a constant.
14 */
15 name: string;
16 /**
17 * Version of the fingerprinting function. If you update your fingerprinting algorithm,
18 * increment this constant.
19 */
20 version: string;
21 /**
22 * A shorter name. This should be a constant.
23 */
24 abbreviation: string;
25 /**
26 * Full data of the fingerprint: whatever text identifies the property you're representing.
27 *
28 * This might be a stringified map of dependency to version, for instance.
29 */
30 data: string;
31 /**
32 * A short string that identifies the data uniquely. Used for fast comparison
33 */
34 sha: string;
35}