TypeScript函数返回空值报错：uuid为空时如何正确返回空？

可正常运行的代码 #

export interface PlayersResponse {
    status: number;
    maxplayers: number;
    online: number;
    players: string[];
}

const getPlayers = async (uuid: string): Promise<PlayersResponse> => {
    const { data } = await http.get(`/api/client/servers/${uuid}/status`);
    return (data.data || []);
};

无法正常运行的代码 #

export interface PlayersResponse {
    status: number;
    maxplayers: number;
    online: number;
    players: string[];
}

const getPlayers = async (uuid: string): Promise<PlayersResponse> => {
    if(uuid === "") return [];
    const { data } = await http.get(`/api/client/servers/${uuid}/status`);
    return (data.data || []);
};

报错原因 #

你定义的getPlayers函数返回类型是Promise<PlayersResponse>，要求必须返回完全符合PlayersResponse接口结构的对象——必须包含status、maxplayers、online、players四个必填属性。

而你尝试的return []返回的是数组，return;返回的是undefined，两者都和PlayersResponse的结构完全不匹配，因此TypeScript抛出类型错误，提示返回值缺少接口要求的属性。

实现需求的两种方案 #

方案1：修改函数返回类型，允许返回空值 #

如果需要在UUID为空时返回“空值”，可以将函数返回类型调整为Promise<PlayersResponse | null>，适配空值场景：

export interface PlayersResponse {
    status: number;
    maxplayers: number;
    online: number;
    players: string[];
}

const getPlayers = async (uuid: string): Promise<PlayersResponse | null> => {
    if(uuid === "") return null;
    const { data } = await http.get(`/api/client/servers/${uuid}/status`);
    return (data.data || null);
};

方案2：返回符合接口结构的空状态对象 #

如果不想修改返回类型，可以返回一个满足PlayersResponse结构的默认对象，用来表示空状态：

export interface PlayersResponse {
    status: number;
    maxplayers: number;
    online: number;
    players: string[];
}

const getPlayers = async (uuid: string): Promise<PlayersResponse> => {
    if(uuid === "") {
        return {
            status: 0, // 可根据业务逻辑设置合适的默认值
            maxplayers: 0,
            online: 0,
            players: []
        };
    }
    const { data } = await http.get(`/api/client/servers/${uuid}/status`);
    return (data.data || {
        status: 0,
        maxplayers: 0,
        online: 0,
        players: []
    });
};

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