@types/github-url-from-git/README.md

TypeScript definitions for github-url-from-git

# Installation
> `npm install --save @types/github-url-from-git`

# Summary
This package contains type definitions for github-url-from-git (https://github.com/tj/node-github-url-from-git).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/github-url-from-git.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/github-url-from-git/index.d.ts)
````ts
declare namespace githubUrlFromGit {
    interface githubUrlFromGitOptions {
        /**
         * additional URLs that should be treated as GitHub repos
         */
        extraBaseUrls?: string[] | undefined;
    }

    /**
     * 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;

````

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

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