hur man använder TypeScript Compiler API för att få information om vanliga funktioner, t.ex.: returtyp/parametrar?

/**
 * class of User
 */
class User {
    /**
     * constructor
     * @param name c-name
     */
    constructor(name: string) {
        this.name = name
    }
    /**
     * property name
     */
    private name: string
    /**
     * setName
     * @param name f-name
     */
    public setName(name: string) {
        this.name = name
    }
}

Jag såg Typescript Wiki och jag kan få konstruktörens information, t.ex.: returnType/parametrar.

[
    {
        "name": "User",
        "documentation": "class of User",
        "type": "typeof User",
        "constructors": [
            {
                "parameters": [
                    {
                        "name": "name",
                        "documentation": "c-name",
                        "type": "string"
                    }
                ],
                "returnType": "User",
                "documentation": "constructor"
            }
        ]
    }
]

men jag vill få informationen om returnType/parametrar/dokumentation på den vanliga funktionen getName, hur kan jag göra detta?

ps: Jag vet att konstruktorn har signaturerna, signaturerna har en funktion getReturntype, men de vanliga funktionerna har inga signaturer, så jag kan inte få informationen

tack!

Svar #1

Förutsatt att du vet hur man får MethodDeclaration, kommer följande att fungera:

// I'm assuming you know how to get the type checker from the compiler too.
const typeChecker = ...;
// Navigate through the tree to get to the method declaration located in the class.
// This is the node with kind === ts.SyntaxKind.MethodDeclaration or
// you can use ts.isMethodDeclaration(node)
const methodDeclaration = ... as ts.MethodDeclaration;

const signature = typeChecker.getSignatureFromDeclaration(methodDeclaration);
const returnType = typeChecker.getReturnTypeOfSignature(signature);
const parameters = methodDeclaration.parameters; // array of Parameters
const docs = methodDeclaration.jsDoc; // array of js docs

Förresten, du borde kolla in denna AST-visare som jag skrev. Den kan hjälpa dig med några framtida frågor du har. Dessutom, beroende på ditt användningsområde, ts-morph som kommer att göra det lite lättare att navigera och manipulera AST.

Relaterade artiklar