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
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
Credits
These definitions were written by Eduardo Silva, and Raúl Cruz.