# @types/github-label-sync

> TypeScript definitions for github-label-sync

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

## Install

```sh
npm install @types/github-label-sync
pnpm add @types/github-label-sync
yarn add @types/github-label-sync
bun add @types/github-label-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.3.3 |
| Published | 2023-11-07 |
| First published | 2020-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51446 |
| Maintainers | types |

## Links

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

## Recent versions

- 2.3.3 (latest) — 2023-11-07
- 2.3.0 (ts4.3) — 2023-08-02
- 2.0.2 (ts3.8) — 2022-01-18
- 2.0.1 (ts3.6) — 2021-07-08
- 2.0.0 (ts3.2) — 2020-10-20
- 2.3.2 — 2023-10-18
- 2.3.1 — 2023-09-20

## README

# Installation
> `npm install --save @types/github-label-sync`

# Summary
This package contains type definitions for github-label-sync (https://github.com/Financial-Times/github-label-sync).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/github-label-sync.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/github-label-sync/index.d.ts)
````ts
export interface BasicLabel {
    name: string;
    color: string;
    description?: string | undefined;
}

export interface LabelInfo extends BasicLabel {
    aliases?: string[] | undefined;
    delete?: boolean | undefined;
}

export interface OptionsBase {
    allowAddedLabels?: boolean | undefined;
    dryRun?: boolean | undefined;
    format?: {
        diff?: ((str: string) => string) | undefined;
        success?: ((str: string) => string) | undefined;
        warning?: ((str: string) => string) | undefined;
    } | undefined;
    labels: LabelInfo[];
    log?: {
        info?: ((str: string) => void) | undefined;
        warn?: ((str: string) => void) | undefined;
    } | undefined;
}

export interface Options extends OptionsBase {
    accessToken: string;
    repo: string;
    endpoint?: string | undefined;
}

export interface DefaultOptions extends Required<OptionsBase> {
    accessToken: null;
    endpoint: null;
    repo: null;
}

export interface LabelDiff {
    name: string;
    type: string;
    actual?: BasicLabel | undefined;
    expected?: BasicLabel | undefined;
}

export const defaults: DefaultOptions;

export default function githubLabelSync(options: Options): Promise<LabelDiff[]>;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: none

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

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