Skip to content
This repository has been archived by the owner on Oct 5, 2021. It is now read-only.

Latest commit

 

History

History
52 lines (31 loc) · 1.21 KB

README.md

File metadata and controls

52 lines (31 loc) · 1.21 KB

typewiz-node

Automatically add types to node.js TypeScript code using typewiz-core

Build Status Coverage Status

Installation

yarn global add typewiz-node

or

npm install -g typewiz-node

Usage

typewiz-node <main.ts>

If you want to enable typewiz for your mocha test, simply add -r typewiz-node/dist/register to your mocha command-line, e.g.:

mocha -r typewiz-node/dist/register src/**/test.ts

This will run your unit tests, discover type information, and write it back to your source files.

Example

Given the following input file:

function greet(who) {
    return `Hello, ${who}`;
}

console.log(greet('Uri'));

Typewiz will run the program and then the code will be updated as following:

function greet(who: string) {
    return `Hello, ${who}`;
}

console.log(greet('Uri'));

Note the addition of the : string type for the who parameter in the first line.

License

MIT