TypeScript项目中Octokit响应字段筛选与类型替换方案

一、替换any类型：使用Octokit内置的类型定义 #

Octokit官方包（包括@octokit/rest、@octokit/core）已经提供了完整的GitHub API响应类型，完全不需要用any来存储结果。以获取组织仓库为例，你可以直接引用内置的类型来约束返回值：

import { Octokit } from "@octokit/rest";

const octokit = new Octokit({ auth: "YOUR_TOKEN" });

// 引用内置的组织仓库列表响应类型
type OrgRepoListResponse = Octokit.Response<Octokit.RestEndpointMethodTypes["repos"]["listForOrg"]["response"]["data"]>;

async function getOrgRepos(orgName: string) {
  // 直接用定义好的类型约束返回值，无需any
  const response: OrgRepoListResponse = await octokit.rest.repos.listForOrg({
    org: orgName,
    per_page: 100,
  });
  return response.data;
}

如果是用octokit.request()方法，同样可以通过泛型参数指定响应数据类型：

async function getOrgReposViaRequest(orgName: string) {
  // 泛型参数指定响应数据的类型
  const response = await octokit.request<Octokit.RestEndpointMethodTypes["repos"]["listForOrg"]["response"]["data"]>(
    "GET /orgs/{org}/repos",
    { org: orgName }
  );
  return response.data;
}

这些内置类型会自动匹配GitHub API返回的结构，包含所有字段的类型定义，完全替代any。

二、实现类似EF Core select()的字段筛选 #

要提取仅需要的字段（比如仓库名称），可以通过以下几种方式实现：

1. 手动解构+自定义DTO类型 #

定义一个只包含所需字段的DTO类型，然后从响应数据中解构提取：

// 自定义DTO，仅保留需要的字段
type MinimalRepo = {
  name: string;
};

async function getOrgRepoNames(orgName: string): Promise<MinimalRepo[]> {
  const response = await octokit.rest.repos.listForOrg({ org: orgName });
  // 解构提取需要的字段，同时自动匹配DTO类型
  return response.data.map(repo => ({ name: repo.name }));
}

2. 使用工具函数封装通用筛选逻辑 #

如果需要频繁使用类似select()的功能，可以封装一个通用函数：

function select<T, K extends keyof T>(items: T[], keys: K[]): Pick<T, K>[] {
  return items.map(item => {
    const result = {} as Pick<T, K>;
    keys.forEach(key => {
      result[key] = item[key];
    });
    return result;
  });
}

// 使用示例
async function getOrgRepoNames(orgName: string) {
  const response = await octokit.rest.repos.listForOrg({ org: orgName });
  // 仅提取name字段
  return select(response.data, ["name"]);
}

这个select函数和EF Core的select()效果类似，通过传入需要的字段名数组，返回只包含指定字段的对象数组，同时保持类型安全。

3. 使用类型断言简化（适合简单场景） #

如果是单次使用，也可以直接用类型断言配合对象字面量：

async function getOrgRepoNames(orgName: string) {
  const response = await octokit.rest.repos.listForOrg({ org: orgName });
  return response.data.map(repo => ({ name: repo.name } as const));
}

总结 #

• Octokit完全支持TypeScript类型约束，内置了所有GitHub API的响应类型，直接引用即可替代any；
• 通过自定义DTO、封装筛选函数或手动解构，就能实现类似EF Core select()的字段筛选功能，保持类型安全的同时减少冗余数据。

内容的提问来源于stack exchange，提问作者Amit Limbasiya