如何在TypeScript参数中定义对象数据类型？

原代码使用any类型定义参数，希望替换为明确的对象类型：

public async index(params: any) {
    return params
}

传入的params结构如下：

{
    "data": {
        "params": {
            "task_id": 101
        }
    }
}

尝试使用object类型后出现错误提示：Property 'params' does not exist on type 'object'，需要解决该类型定义问题。

解决方案 #

1. 定义精确接口类型（推荐） #

为参数结构定义对应的嵌套接口，这是TypeScript中最规范的类型定义方式：

// 定义最内层的任务参数接口
interface TaskParams {
  task_id: number;
}

// 定义data字段的接口
interface DataContent {
  params: TaskParams;
}

// 定义完整的请求参数接口
interface RequestParams {
  data: DataContent;
}

// 使用定义好的接口作为参数类型
public async index(params: RequestParams) {
    // 此时可正常访问 params.data.params.task_id
    return params
}

2. 使用类型别名 #

如果偏好更简洁的写法，也可以用类型别名实现相同效果：

type TaskParams = {
  task_id: number;
}

type DataContent = {
  params: TaskParams;
}

type RequestParams = {
  data: DataContent;
}

public async index(params: RequestParams) {
    return params
}

3. 内联类型定义（快速临时方案） #

若只是简单场景不想单独定义接口/类型，可直接内联书写类型结构：

public async index(params: {
  data: {
    params: {
      task_id: number;
    }
  }
}) {
    return params
}

错误原因说明 #

TypeScript中的object类型是泛指所有非原始类型（即排除string、number、boolean、symbol、null、undefined的类型），但它并未包含任何具体属性的定义，因此TypeScript无法确认参数上存在data或params属性，进而抛出错误。必须定义包含具体属性结构的类型，才能让TypeScript识别并允许访问这些属性。

内容的提问来源于stack exchange，提问作者positive developer