Skip to content

feat: add typescript type definitions #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JamieMagee wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add typescript type definitions #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;