ts-type-info's Introduction

TSTypeInfo

Reflection and code generation in TypeScript.

Uses the TypeScript Compiler API to get the type and structure information of TypeScript code in an easily usable format.

npm install ts-type-info --save-dev
tsd link

Reflection

// V:/TestFile.ts

function myDecorator(str: string) {
    return (target: typeof MyClass) => {
        target.myStaticProperty = str;
    };
}

@myDecorator("My decorator value")
export class MyClass {
    static myStaticProperty: string | number;

    myProperty = 253;

    myMethod(myParameter: string) {
        return `Test: ${myParameter}`;
    }
}

Get the file info:

import * as TsTypeInfo from "ts-type-info";

const files = TsTypeInfo.getFileInfo(["V:/TestFile.ts"]);
const myPropertyName = files[0].classes[0].properties[0].name;

console.log(myPropertyName); // myProperty

Code Generation

// V:/TestFile2.ts

class MyClass {
    myMethod(str: string) {
    }
}

Get the file info and tell it how it should output:

import * as TsTypeInfo from "ts-type-info";

const files = TsTypeInfo.getFileInfo(["V:/TestFile2.ts"]);
const myClass = files[0].classes[0];

myClass.isAbstract = true;
myClass.onBeforeWrite = writer => writer.write("@MyDecorator");
myClass.methods[0].onBeforeWrite = writer => writer.write("// myMethod is here");
myClass.methods[0].onWriteFunctionBody = writer => {
    writer.write(`if (str != null && str.length > 40)`).block(() => {
        writer.write("alert(str)");
    });
    writer.newLine().write("return str;");
};

console.log(myClass.write());

Outputs:

@MyDecorator
abstract class MyClass {
    // myMethod is here
    myMethod(str: string) {
        if (str != null && str.length > 40) {
            alert(str);
        }

        return str;
    }
}