# @types/bump-regex

> TypeScript definitions for bump-regex

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

## Install

```sh
npm install @types/bump-regex
pnpm add @types/bump-regex
yarn add @types/bump-regex
bun add @types/bump-regex
```

## 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 | 4.1.4 |
| Published | 2023-11-07 |
| First published | 2017-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

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

## Recent versions

- 4.1.4 (latest) — 2023-11-07
- 4.1.1 (ts3.6) — 2021-07-08
- 4.1.0 (ts3.5) — 2021-05-27
- 2.9.0 (ts2.0) — 2017-12-15
- 4.1.3 — 2023-10-17
- 4.1.2 — 2023-09-15

## README

# Installation
> `npm install --save @types/bump-regex`

# Summary
This package contains type definitions for bump-regex (https://github.com/stevelacy/bump-regex).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bump-regex.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bump-regex/index.d.ts)
````ts
declare function bump(opts: string | bump.Options, cb: bump.Callback): any;

declare namespace bump {
    type Callback = (err: string | Error | null, opts?: Result) => void;

    interface Options {
        key?: string | undefined;
        type?: "major" | "minor" | "patch" | "prerelease" | undefined;
        case?: boolean | undefined;
        keys?: string[] | undefined;
        /**
         * Keep the metadata of the old version after bumping
         * @default false
         */
        keepmetadata?: boolean | undefined;
        global?: boolean | undefined;
        version?: string | undefined;
        preid?: string | undefined;
        regex?: RegExp | undefined;
        str?: string | undefined;
    }

    interface Result extends Options {
        prev: string;
        new: string;
    }
}

export = bump;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: none

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

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