3.0.5 • Published 6 months ago
@types/issue-parser v3.0.5
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
// Type definitions for issue-parser 3.0
// Project: https://github.com/pvdlg/issue-parser#readme
// Definitions by: Leko <https://github.com/Leko>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.2
declare function issueParser(
authOptions?: issueParser.Options,
extension?: issueParser.Overrides
): issueParser.Parser;
declare namespace issueParser {
type Parser = (text: string) => Result;
interface Overrides {
actions?: {
[type: string]: ReadonlyArray<string>;
} | undefined;
delimiters?: string | ReadonlyArray<string> | undefined;
mentionsPrefixes?: string | ReadonlyArray<string> | undefined;
issuePrefixes?: string | ReadonlyArray<string> | undefined;
hosts?: string | ReadonlyArray<string> | undefined;
issueURLSegments?: string | ReadonlyArray<string> | undefined;
overrides?: string | ReadonlyArray<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]: ReadonlyArray<Action>;
}
interface Result {
refs: ReadonlyArray<Reference>;
mentions: ReadonlyArray<Mention>;
actions: Actions;
allRefs: Array<Reference | Action>;
}
}
export = issueParser;
Additional Details
- Last updated: Thu, 08 Jul 2021 14:23:21 GMT
- Dependencies: none
- Global values: none
Credits
These definitions were written by Leko.