# @types/gfc

> TypeScript definitions for gfc

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

## Install

```sh
npm install @types/gfc
pnpm add @types/gfc
yarn add @types/gfc
bun add @types/gfc
```

## 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.4 |
| Published | 2023-11-07 |
| First published | 2018-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

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

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 2.0.4 (latest) — 2023-11-07
- 2.0.1 (ts3.6) — 2021-07-08
- 2.0.0 (ts2.1) — 2018-12-25
- 2.0.3 — 2023-10-18
- 2.0.2 — 2023-09-20

## README

# Installation
> `npm install --save @types/gfc`

# Summary
This package contains type definitions for gfc (https://github.com/jonschlinkert/gfc).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gfc.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gfc/index.d.ts)
````ts
/// <reference types="node" />

import { ExecException, ExecOptions, ExecSyncOptions } from "child_process";

export = gitFirstCommit;

declare function gitFirstCommit(
    options?: gitFirstCommit.Options<gitFirstCommit.ExecOptionsWithEncoding>,
): Promise<{ stdout: string | Buffer; stderr: string | Buffer }>;
declare function gitFirstCommit(
    cwd: string,
    options?: gitFirstCommit.Options<gitFirstCommit.ExecOptionsWithEncoding>,
): Promise<{ stdout: string | Buffer; stderr: string | Buffer }>;
declare function gitFirstCommit(
    cwd: string,
    callback: (
        error: ExecException | null,
        stdout: string | Buffer,
        stderr: string | Buffer,
    ) => void,
): void;
declare function gitFirstCommit(
    cwd: string,
    options: gitFirstCommit.Options<gitFirstCommit.ExecOptionsWithEncoding>,
    callback: (
        error: ExecException | null,
        stdout: string | Buffer,
        stderr: string | Buffer,
    ) => void,
): void;

declare namespace gitFirstCommit {
    function sync(options?: Options<ExecSyncOptions>): string | Buffer;
    function sync(cwd: string, options?: Options<ExecSyncOptions>): string | Buffer;

    type ExecOptionsWithEncoding = { encoding?: BufferEncoding | "buffer" | null | undefined } & ExecOptions;

    interface Options<TExecOptions> {
        cwd?: string | undefined;
        exec?: TExecOptions | undefined;
        message?: string | undefined;
        file?: { path: string; contents?: string | undefined } | false | undefined;
        commit?: boolean | undefined;
        forceFile?: boolean | undefined;
        remote?: string | undefined;
        push?: boolean | undefined;
    }
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [BendingBender](https://github.com/BendingBender).

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