# @types/express-actuator

> TypeScript definitions for express-actuator

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

## Install

```sh
npm install @types/express-actuator
pnpm add @types/express-actuator
yarn add @types/express-actuator
bun add @types/express-actuator
```

## 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.8.3 |
| Published | 2023-11-07 |
| First published | 2019-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51448 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.8.3 (latest) — 2023-11-07
- 1.8.0 (ts3.7) — 2021-09-01
- 1.6.2 (ts3.6) — 2021-07-08
- 1.6.1 (ts3.2) — 2020-11-09
- 1.6.0 (ts3.0) — 2020-07-29
- 1.3.0 (ts2.3) — 2019-11-05
- 1.8.2 — 2023-10-18
- 1.8.1 — 2023-09-23

## README

# Installation
> `npm install --save @types/express-actuator`

# Summary
This package contains type definitions for express-actuator (https://www.npmjs.org/package/express-actuator).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-actuator.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-actuator/index.d.ts)
````ts
import express = require("express");

declare function actuator(options?: actuator.Options): express.RequestHandler;

declare namespace actuator {
    type InfoGitMode = "simple" | "full";

    /**
     * @summary Options for {@link Actuator} function.
     */
    interface Options {
        /**
         * @summary BasePath of Actuator.
         */
        basePath?: string | undefined;

        /**
         * @summary infoGitMode.
         */
        infoGitMode?: InfoGitMode | undefined;

        /**
         * @summary DateFormat for info git.time output.
         */
        infoDateFormat?: string | undefined;

        /**
         * @summary Extra Options to pass to info build output.
         */
        infoBuildOptions?: Record<string, any> | undefined;

        /**
         * @summary Custom endpoints
         */
        customEndpoints?: CustomEndpoint[] | undefined;
    }

    interface CustomEndpoint {
        /**
         * @summary Used as endpoint `/id` or `${basePath}/id`
         */
        id: string;

        /**
         * @summary Controller to be called when accessing this endpoint
         */
        controller: CustomControllerMethod;
    }

    interface CustomControllerMethod {
        (req?: any, res?: any): void;
    }
}

export = actuator;

````

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

# Credits
These definitions were written by [ Eduardo Silva](https://github.com/etruta), and [Raúl Cruz](https://github.com/rcruzper).

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