node.js - Typescript 中第三方模块的声明文件

Question

我在集成刚刚为第 3 方包“newrelic ”制作的声明文件时遇到了一些问题。当我运行 tsc 时，我总是收到下一条错误消息:

src/Server.ts(17,7): error TS2322: Type '{ express: typeof e; newrelic: typeof 'newrelic'; }' is not assignable to type 'BootServicesInterface'.

属性“newrelic”的类型不兼容。 类型“typeof 'newrelic'”不可分配给类型“newrelic”。 类型“typeof 'newrelic'”中缺少属性“setTransactionName”。

有谁可以解决这个错误吗？我已经为此工作了几个小时，但我看不出我做错了什么。源文件:

./src/Server.ts

'use strict'

import * as debugDep from 'debug'
const debug = debugDep('server')
debug('Booting Server')

debug('Loading .env file')
import * as dotenv from 'dotenv'
dotenv.config({silent: true})

debug('Loading System Dependencies')
import * as express from 'express'
import * as newrelic from 'newrelic'
import {BootClass, BootServicesInterface} from './Core/Boot'

debug('Setup Webserver')
const Services: BootServicesInterface = {
  express,
  newrelic,
}

const boot = new BootClass(Services)

./src/Core/Boot.ts

'use strict'
import * as express from 'express'
import * as newrelic from 'newrelic'

export interface BootClassInterface {
  setup(): express.Express
}

export interface BootServicesInterface {
  newrelic: newrelic.newrelic
  express(): express.Express,
}

export class BootClass implements BootClassInterface {

  private services: BootServicesInterface

  public constructor(services: BootServicesInterface) {
    this.services = services
  }

}

./@CustomTypes/newrelic/index.d.ts:

declare module 'newrelic' {
    export interface newrelic {
      setTransactionName: (name: string) => void,
      setControllerName: (name: string, action?: {}) => void,
      createWebTransaction: (url: string, handler: Function) => void,
      createBackgroundTransaction(name: string, group: string | null | undefined, handler: Function): void,
      createBackgroundTransaction(name: string, handler: Function): void,
      endTransaction: () => void,
      createTracer: (name: string, callback: Function) => void,
      recordMetric: (name: string, value: number | {count: number, total: number, min: number, max: number, sumOfSquares: number}) => void,
      incrementMetric: (name: string, amount?: number) => void,
      recordCustomEvent: (eventType: string, attributes: {}) => void,
      addCustomParameter: (name: string, value: string | number) => void,
      addCustomParameters: (params : {}) => void,
      getBrowserTimingHeader: () => string,
      setIgnoreTransaction: (ignored: boolean) => void,
      noticeError: (error: Error, customParameters?: {}) => void,
      shutdown(options: Options, callback: Function): void,
      rules: Rules,
      addNamingRule: (pattern: Pattern[], name: string) => void,
      addIgnoringRule: (pattern: string[]) => void,
    }

    export interface Rules {
      name: Pattern[],
      ignore: string[],
    }

    export interface Pattern {
      pattern: string, 
      name: string, 
      terminate_chain?: boolean, 
      replace_all?: boolean, 
      precedence?: boolean
    }

    export interface Options{
      collectPendingData: boolean,
      timeout: number
    }
}

./tsconfig.json

{
    "compilerOptions": {
        "module": "es6",
        "moduleResolution": "node",
        "noImplicitAny": true,
        "noImplicitReturns": true,
        "noImplicitThis": true,
        "noUnusedLocals": true,
        "noUnusedParameters": true,
        "removeComments": false,
        "skipLibCheck": false,
        "sourceMap": false,
        "strictNullChecks": true,
        "target": "ES2016",
        "outDir": "./lib",
        "declaration": true,
        "diagnostics": true,
        "alwaysStrict": true
    },
    "exclude": [
        "node_modules",
        "public"
    ],
    "include": [
        "**/*.d.ts",
        "./src/**/*.ts"
    ],
    "typeRoots": [
        "@CustomTypes",
        "node_modules/@types"
    ],
    "lib": [
        "es6"
    ]
}

Answer 1

我忘记导出函数本身。我当然制作了 newrelic 接口(interface)，但忘记导出函数本身。正确的声明文件应该是:

./@CustomTypes/newrelic/index.d.ts:

declare module 'newrelic' {

  export interface Rules {
    name: Pattern[],
    ignore: string[],
  }

  export interface Pattern {
    pattern: string, 
    name: string, 
    terminate_chain?: boolean, 
    replace_all?: boolean, 
    precedence?: boolean
  }

  export interface Options{
    collectPendingData: boolean,
    timeout: number
  }

  export interface MetricValue{
    count: number, 
    total: number, 
    min: number, 
    max: number, 
    sumOfSquares: number
  }

  export interface newrelic { 
    setTransactionName(name: string): void
    setControllerName(name: string, action: {}): void
    setControllerName(name: string): void
    createWebTransaction(url: string, handler: Function): void
    createBackgroundTransaction(name: string, group: string| null, handler: Function): void
    createBackgroundTransaction(name: string, handler: Function): void
    endTransaction(): void
    createTracer(name: string, callback: Function): void
    recordMetric(name: string, value: number | MetricValue): void
    incrementMetric(name: string, amount?: number): void
    recordCustomEvent(eventType: string, attributes: {}): void
    addCustomParameter(name: string, value: string | number): void
    addCustomParameters(params : {}): void
    getBrowserTimingHeader(): string
    setIgnoreTransaction(ignored: boolean): void
    noticeError(error: Error, customParameters: {}): void
    noticeError(error: Error): void
    shutdown(options: Options, callback: Function): void
    rules: Rules
    addNamingRule(pattern: Pattern[], name: string): void
    addIgnoringRule(pattern: string[]): void
  }

  export function setTransactionName(name: string): void
  export function setControllerName(name: string, action: {}): void
  export function setControllerName(name: string): void
  export function createWebTransaction(url: string, handler: Function): void
  export function createBackgroundTransaction(name: string, group: string| null, handler: Function): void
  export function createBackgroundTransaction(name: string, handler: Function): void
  export function endTransaction(): void
  export function createTracer(name: string, callback: Function): void
  export function recordMetric(name: string, value: number | MetricValue): void
  export function incrementMetric(name: string, amount?: number): void
  export function recordCustomEvent(eventType: string, attributes: {}): void
  export function addCustomParameter(name: string, value: string | number): void
  export function addCustomParameters(params : {}): void
  export function getBrowserTimingHeader(): string
  export function setIgnoreTransaction(ignored: boolean): void
  export function noticeError(error: Error, customParameters: {}): void
  export function noticeError(error: Error): void
  export function shutdown(options: Options, callback: Function): void
  export var rules: Rules
  export function addNamingRule(pattern: Pattern[], name: string): void
  export function addIgnoringRule(pattern: string[]): void
}