# @types/kube-probe

> TypeScript definitions for kube-probe

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

## Install

```sh
npm install @types/kube-probe
pnpm add @types/kube-probe
yarn add @types/kube-probe
bun add @types/kube-probe
```

## 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.0.4 |
| Published | 2023-11-07 |
| First published | 2020-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

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

## Dependencies (2)

- [@types/express](https://npm.io/package/@types/express.md) *
- [@types/overload-protection](https://npm.io/package/@types/overload-protection.md) *

## Recent versions

- 1.0.4 (latest) — 2023-11-07
- 1.0.1 (ts3.6) — 2021-07-08
- 1.0.0 (ts3.2) — 2020-10-12
- 1.0.3 — 2023-10-18
- 1.0.2 — 2023-09-14

## README

# Installation
> `npm install --save @types/kube-probe`

# Summary
This package contains type definitions for kube-probe (https://github.com/nodeshift/kube-probe).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/kube-probe.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/kube-probe/index.d.ts)
````ts
import { Express } from "express";
import { ProtectionConfig } from "overload-protection";

interface Options {
    readinessUrl?: string | undefined;
    livenessUrl?: string | undefined;
    readinessCallback?: (() => void) | undefined;
    livenessCallback?: (() => void) | undefined;
    bypassProtection?: boolean | undefined;
    protectionConfig?: ProtectionConfig | undefined;
}
declare function probe(app: Express, options?: Options): void;

export = probe;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:38 GMT
 * Dependencies: [@types/express](https://npmjs.com/package/@types/express), [@types/overload-protection](https://npmjs.com/package/@types/overload-protection)

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

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