TypeScript Definition

[JoeChapman]

Add a TypeScript Definition file

[elisherer]

This works for me...

Create a file src/@types/api-express-reporter.d.ts:

module "api-express-exporter" {
  type ApiExpressExporterOptions = {
    /** host string for the metrics server. Defaults to 127.0.0.1 */
    host?: string;
    /** port that metrics server listens on. Defaults to 9991 */
    port?: number;
    /** function to create the url pattern matcher, defaults to (path) => new UrlPattern(path, { segmentNameCharset: "a-zA-Z0-9_-" }) */
    urlPatternMaker?: (path: string) => any;
    /** Set this to false to use the original url instead of cleaned up ones. */
    normalizePath?: boolean;
    /** Set this to false to not create the exporter server endpoint */
    createServer?: boolean;
    /** Use this to pass in a custom logger function. Useful when you're using pino, bunyan, winston, or another custom logger. Defaults to console.log */
    logger?: typeof console.log;

    discardUnmatched?: boolean;
  };

  export default function makeApiMiddleware(options?: ApiExpressExporterOptions): any;
}