# @types/issue-parser

> TypeScript definitions for issue-parser

Latest version **3.0.5** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/issue-parser
pnpm add @types/issue-parser
yarn add @types/issue-parser
bun add @types/issue-parser
```

## 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 | 3.0.5 |
| Published | 2023-11-21 |
| First published | 2018-12-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51441 |
| Maintainers | types |

## Links

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

## Recent versions

- 3.0.5 (latest) — 2023-11-21
- 3.0.1 (ts3.6) — 2021-07-08
- 3.0.0 (ts2.2) — 2018-12-21
- 3.0.4 — 2023-11-07
- 3.0.3 — 2023-10-18
- 3.0.2 — 2023-09-26

## README

# Installation
> `npm install --save @types/issue-parser`

# Summary
This package contains type definitions for issue-parser (https://github.com/pvdlg/issue-parser#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/issue-parser.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/issue-parser/index.d.ts)
````ts
declare function issueParser(
    authOptions?: issueParser.Options,
    extension?: issueParser.Overrides,
): issueParser.Parser;

declare namespace issueParser {
    type Parser = (text: string) => Result;
    interface Overrides {
        actions?: {
            [type: string]: readonly string[];
        } | undefined;
        delimiters?: string | readonly string[] | undefined;
        mentionsPrefixes?: string | readonly string[] | undefined;
        issuePrefixes?: string | readonly string[] | undefined;
        hosts?: string | readonly string[] | undefined;
        issueURLSegments?: string | readonly string[] | undefined;
        overrides?: string | readonly string[] | undefined;
    }
    type Options = "github" | "gitlab" | "bitbucket" | "waffle" | Overrides;
    interface Reference {
        raw: string;
        slug: string | undefined;
        prefix: string | undefined;
        issue: string;
    }
    interface Mention {
        raw: string;
        prefix: string;
        user: string;
    }
    interface Action {
        raw: string;
        action: string;
        slug: string | undefined;
        prefix: string | undefined;
        issue: string;
    }
    interface Actions {
        [action: string]: readonly Action[];
    }
    interface Result {
        refs: readonly Reference[];
        mentions: readonly Mention[];
        actions: Actions;
        allRefs: Array<Reference | Action>;
    }
}

export = issueParser;

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: none

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

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