# @types/git-rev-sync

> TypeScript definitions for git-rev-sync

Latest version **2.0.2** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/git-rev-sync
pnpm add @types/git-rev-sync
yarn add @types/git-rev-sync
bun add @types/git-rev-sync
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2023-11-07 |
| First published | 2018-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/git-rev-sync
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/git-rev-sync
- npm.io page: https://npm.io/package/@types/git-rev-sync

## Recent versions

- 2.0.2 (latest) — 2023-11-07
- 2.0.0 (ts2.9) — 2020-05-12
- 1.12.0 (ts2.0) — 2018-10-27
- 2.0.1 — 2023-10-18

## README

# Installation
> `npm install --save @types/git-rev-sync`

# Summary
This package contains type definitions for git-rev-sync (https://github.com/kurttheviking/git-rev-sync-js).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/git-rev-sync.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/git-rev-sync/index.d.ts)
````ts
export function branch(filePath?: string): string;
export function count(): number;
export function date(): Date;
export function hasUnstagedChanges(): boolean;
export function isDirty(): boolean;
export function isTagDirty(): boolean;
export function long(filePath?: string): string;
export function message(): string;
export function remoteUrl(): string;
export function short(filePath?: string, length?: number): string;
export function tag(makeDirty?: boolean): string;
export function tagFirstParent(makeDirty?: boolean): string;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: none

# Credits
These definitions were written by [khoi-fish](https://github.com/khoi-fish), and [pkuczynski](https://github.com/pkuczynski).

---
_Source: https://npm.io/package/@types/git-rev-sync · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
