如何正确调用TypeScript中Auth0Module的register方法？

参数规则说明 #

register 是典型的NestJS动态模块注册方法，仅接收1个对象类型的入参，结构要求如下：

• 必须包含options属性，属性值需符合Auth0Options接口规范：
  • 必填项：domain（Auth0服务域名）、clientId（应用客户端ID）、clientSecret（应用客户端密钥）
  • 可选项：audience（API受众标识）、namespace（自定义命名空间）
• 支持传入任意数量的其他自定义键值对（对应类型定义的索引签名[name: string]: any），这部分是预留的扩展参数位，用于支持自定义注入依赖、功能开关配置等场景，常规使用不需要传这类额外参数。

正确调用示例 #

在NestJS的根模块或业务模块中导入时按如下写法即可：

import { Module } from '@nestjs/common';
import { Auth0Module } from '对应auth0库的导入路径';

@Module({
  imports: [
    Auth0Module.register({
      options: {
        domain: '你的Auth0租户域名，示例：demo-app.us.auth0.com',
        clientId: '从Auth0控制台复制的应用Client ID',
        clientSecret: '从Auth0控制台复制的应用Client Secret',
        // 以下两个参数按需配置即可，不需要可以不传
        audience: 'https://你的api服务标识',
        namespace: 'https://demo-app.us.auth0.com/'
      }
    })
  ]
})
export class AppModule {}

常见错误写法 #

不要把Auth0的连接配置直接平铺在register的入参对象里，TS会直接抛出类型错误：

// ❌ 错误：缺少options字段，配置直接平铺
Auth0Module.register({
  domain: 'demo-app.us.auth0.com',
  clientId: 'xxxx',
  clientSecret: 'xxxx'
})

内容的提问来源于stack exchange，提问作者Nick Hodges