1 | # Installation
|
2 | > `npm install --save @types/git-semver-tags`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for git-semver-tags (https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-semver-tags#readme).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/git-semver-tags.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/git-semver-tags/index.d.ts)
|
10 | ````ts
|
11 | // Type definitions for git-semver-tags 4.1
|
12 | // Project: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-semver-tags#readme
|
13 | // Definitions by: Jason Kwok <https://github.com/JasonHK>
|
14 | // Piotr Błażejewicz <https://github.com/peterblazejewicz>
|
15 | // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
16 |
|
17 | /**
|
18 | * Get all git semver tags of your repository in reverse chronological order
|
19 | */
|
20 | declare function gitSemverTags(options: gitSemverTags.Options, callback: gitSemverTags.Callback): void;
|
21 | declare function gitSemverTags(callback: gitSemverTags.Callback): void;
|
22 |
|
23 | declare namespace gitSemverTags {
|
24 | type Callback = (error: any, tags: string[]) => void;
|
25 |
|
26 | interface Options {
|
27 | /**
|
28 | * Extract lerna style tags (`foo-package@2.0.0`) from the git history, rather
|
29 | * than `v1.0.0` format.
|
30 | */
|
31 | lernaTags?: boolean | undefined;
|
32 |
|
33 | /**
|
34 | * What package should lerna style tags be listed for, e.g., `foo-package`.
|
35 | */
|
36 | package?: string | undefined;
|
37 |
|
38 | /**
|
39 | * Specify a prefix for the git tag to be ignored from the semver checks.
|
40 | */
|
41 | tagPrefix?: string | undefined;
|
42 |
|
43 | /**
|
44 | * If given, unstable tags (e.g. `x.x.x-alpha.1`, `x.x.x-rc.2`) will be skipped.
|
45 | */
|
46 | skipUnstable?: boolean | undefined;
|
47 | }
|
48 | }
|
49 |
|
50 | export = gitSemverTags;
|
51 |
|
52 | ````
|
53 |
|
54 | ### Additional Details
|
55 | * Last updated: Thu, 08 Jul 2021 12:02:08 GMT
|
56 | * Dependencies: none
|
57 | * Global values: none
|
58 |
|
59 | # Credits
|
60 | These definitions were written by [Jason Kwok](https://github.com/JasonHK), and [Piotr Błażejewicz](https://github.com/peterblazejewicz).
|
61 |
|
\ | No newline at end of file |