# @types/github-url-from-git

> TypeScript definitions for github-url-from-git

Latest version **1.5.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/github-url-from-git
pnpm add @types/github-url-from-git
yarn add @types/github-url-from-git
bun add @types/github-url-from-git
```

## 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 | 1.5.3 |
| Published | 2023-11-07 |
| First published | 2019-09-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51429 |
| Maintainers | types |

## Links

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

## Recent versions

- 1.5.3 (latest) — 2023-11-07
- 1.5.1 (ts3.6) — 2021-07-08
- 1.5.0 (ts2.0) — 2019-09-24
- 1.5.2 — 2023-10-18

## README

# 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).

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