diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..9e53e19 --- /dev/null +++ b/index.d.ts @@ -0,0 +1,29 @@ +declare namespace githubUrlFromGit { + interface githubUrlFromGitOptions { + /** + * additional URLs that should be treated as GitHub repos + */ + extraBaseUrls?: string[]; + } + + /** + * Create a regular expression to parse GitHub URLs + * + * @param opts options for regular expression generator + */ + function re(opts?: githubUrlFromGitOptions): RegExp; +} + +/** + * Normalize Git URLs into GitHub URLs + * + * @param url Git URL to process + * @param opts options for URL parser + * @returns GitHub URL + */ +declare function githubUrlFromGit( + url: string, + opts?: githubUrlFromGit.githubUrlFromGitOptions +): string; + +export = githubUrlFromGit;