Fastify使用decorate注册db后提示Property 'db'不存在如何解决？

报错原因 #

该报错为TypeScript类型校验错误：你通过fastify.decorate给Fastify实例扩展了db属性，但Fastify默认类型定义中未包含db属性的声明，因此触发类型不匹配提示。

解决方案 #

方案一：扩展Fastify类型定义（推荐，TS/开启TS校验的JS项目通用） #

在项目中新增类型声明文件（可命名为fastify.d.ts放在根目录或types文件夹下），补充db属性的类型声明：

import type { FastifyInstance } from 'fastify'

// 替换为你实际使用的数据库客户端类型，如PgClient、MongoClient等
type YourDbClientType = {
  // 补充客户端的属性、方法类型定义
  query: (sql: string, params?: any[]) => Promise<any>
  connect: () => Promise<void>
}

declare module 'fastify' {
  interface FastifyInstance {
    db: {
      client: YourDbClientType
    }
  }
}

之后在tsconfig.json的include配置项中添加该声明文件的路径，确保TypeScript可以读取到扩展的类型。

方案二：临时绕过类型校验（仅临时调试用，不推荐长期使用） #

如果不需要严格的类型校验，可以通过以下方式绕过提示：

• JS项目在调用行上方加注释：// @ts-ignore
• TS项目用类型断言：const db = (fastify as any).db

注意事项 #

• 确保调用fastify.db的时机在插件注册完成之后：fastify.register是异步方法，建议在fastify.ready()回调中执行业务逻辑，或在异步函数中先await fastify.ready()再调用fastify.db，避免运行时也出现属性不存在的问题。
• 现有插件代码未处理数据库连接断开后的重连逻辑，建议后续补充相关错误处理，避免运行时故障。

内容的提问来源于stack exchange，提问作者buddha tamang