Codepipeline SDK v3中TypeScript对象可能未定义的类型检查问题

我在Lambda中编写了一个获取CodePipeline执行ID的简单函数，但由于SDK包中原对象为可选类型，无法通过TypeScript类型检查。代码如下：

async function getPipelineExecutionId(pipelineName: string): Promise<string> {
  const pipelineParams = {
    name: pipelineName,
  };
  const codePipelineClient = new CodePipelineClient({ region: region });
  const codePipelineCommand = new GetPipelineStateCommand(pipelineParams);
  const pipelineInfo = await codePipelineClient.send(codePipelineCommand);

  const executionId = pipelineInfo.stageStates[2].latestExecution.pipelineExecutionId //ts错误

  return executionId
}

错误信息：

'pipelineInfo.stageStates' 可能为 'undefined'。ts(18048)
对象可能为 'undefined'。

问题根源是AWS SDK v3定义的GetPipelineStateCommand返回类型中，stageStates是可选数组，且数组元素的latestExecution也是可选属性，TypeScript的严格空值检查不允许直接访问可能为undefined的属性或数组下标。以下是几种可行的解决方式：

方式一：可选链+空值合并+错误抛出 #

使用?.安全访问嵌套属性与数组下标，同时用空值判断确保返回有效字符串：

async function getPipelineExecutionId(pipelineName: string): Promise<string> {
  const pipelineParams = { name: pipelineName };
  const codePipelineClient = new CodePipelineClient({ region: region });
  const codePipelineCommand = new GetPipelineStateCommand(pipelineParams);
  const pipelineInfo = await codePipelineClient.send(codePipelineCommand);

  const executionId = pipelineInfo.stageStates?.[2]?.latestExecution?.pipelineExecutionId;
  if (!executionId) {
    throw new Error("无法获取Pipeline执行ID：目标stage不存在、未执行或无有效ID");
  }
  return executionId;
}

这种方式兼顾代码简洁性与类型安全性，能覆盖所有空值场景，且在异常时提供明确的错误信息。

方式二：显式分层空值检查 #

逐层级验证属性与数组的有效性，针对不同场景抛出精准错误：

async function getPipelineExecutionId(pipelineName: string): Promise<string> {
  const pipelineParams = { name: pipelineName };
  const codePipelineClient = new CodePipelineClient({ region: region });
  const codePipelineCommand = new GetPipelineStateCommand(pipelineParams);
  const pipelineInfo = await codePipelineClient.send(codePipelineCommand);

  // 检查stageStates是否存在且有足够元素
  if (!pipelineInfo.stageStates || pipelineInfo.stageStates.length <= 2) {
    throw new Error("Pipeline的stage数量不足，无法获取第3个stage的执行信息");
  }
  const targetStage = pipelineInfo.stageStates[2];
  // 检查目标stage是否有执行记录
  if (!targetStage.latestExecution) {
    throw new Error("目标stage尚未执行，无可用执行ID");
  }
  // 检查执行ID是否有效
  const executionId = targetStage.latestExecution.pipelineExecutionId;
  if (!executionId) {
    throw new Error("获取到的Pipeline执行ID无效");
  }
  return executionId;
}

这种方式适合需要精准定位问题场景的情况，便于调试和排查错误。

方式三：类型断言（谨慎使用） #

如果你能绝对保证stageStates存在且至少有3个元素，latestExecution和pipelineExecutionId必然非空，可以用类型断言跳过TypeScript的检查：

async function getPipelineExecutionId(pipelineName: string): Promise<string> {
  const pipelineParams = { name: pipelineName };
  const codePipelineClient = new CodePipelineClient({ region: region });
  const codePipelineCommand = new GetPipelineStateCommand(pipelineParams);
  const pipelineInfo = await codePipelineClient.send(codePipelineCommand);

  const executionId = (pipelineInfo.stageStates as NonNullable<typeof pipelineInfo.stageStates>)[2]
    .latestExecution!
    .pipelineExecutionId!;
  return executionId;
}

注意：这种方式会绕过TypeScript的安全校验，若实际运行中出现空值，会直接触发运行时错误，仅在数据结构完全可控的场景下使用。

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