在ts-morph中获取TypeScript函数参数的默认值

概述

在使用ts-morph进行TypeScript代码分析时，我们经常需要获取函数参数的详细信息，特别是参数的默认值。本文将详细介绍如何通过ts-morph的API来提取函数参数的默认值表达式。

核心概念

在TypeScript中，函数参数可以设置默认值，当调用函数时如果没有提供该参数值，就会使用这个默认值。例如：

function example(param1: string = "default") {
    // 函数体
}

在这个例子中，参数param1有一个字符串类型的默认值"default"。

使用ts-morph获取默认值

ts-morph提供了强大的API来分析和操作TypeScript代码。要获取函数参数的默认值，可以按照以下步骤操作：

1. 首先获取目标函数的声明节点
2. 然后遍历函数的参数列表
3. 对每个参数检查是否存在初始化表达式
4. 如果有初始化表达式，则可以进一步分析其内容

以下是具体的代码示例：

// 获取源文件中的函数声明
const functionDeclaration = sourceFile.getFunctionOrThrow("example");

// 获取所有参数
const parameters = functionDeclaration.getParameters();

// 遍历参数
for (const param of parameters) {
    // 获取初始化表达式
    const initializer = param.getInitializer();
    
    if (initializer) {
        // 获取初始化表达式的文本表示
        const defaultValueText = initializer.getText();
        
        // 根据表达式类型进行不同处理
        switch (initializer.getKind()) {
            case ts.SyntaxKind.StringLiteral:
                // 处理字符串字面量
                break;
            case ts.SyntaxKind.NumericLiteral:
                // 处理数字字面量
                break;
            // 其他类型的处理...
        }
    }
}

高级用法

对于更复杂的场景，你可能需要：

1. 类型检查：使用getType()方法获取参数的类型信息
2. 表达式分析：对于复杂的默认值表达式，可以进一步解析其结构
3. 默认值修改：使用setInitializer()方法修改参数的默认值

注意事项

1. 不是所有参数都有默认值，使用前务必检查getInitializer()的返回值
2. 默认值表达式可能是任意复杂的TypeScript表达式，而不仅仅是简单字面量
3. 对于箭头函数等不同形式的函数声明，获取方式略有不同

总结

通过ts-morph提供的API，我们可以方便地分析和操作TypeScript函数参数的默认值。这在代码生成、代码转换和静态分析等场景中非常有用。掌握这些技巧可以帮助开发者更好地理解和操作TypeScript代码结构。