typescript-handler v0.1.1

typescript-handler

Expressive NodeJS module for importing and managing TS compilation at runtime. You can require existing modules written in TS and forget about the compilation process. Typescript-handler will compile the TS in-memory and return the JS module as appropriate.

How to use

Load a TS module in-memory

var ts = require('typescript-handler');

// Import your TS module.
var myTsModule = ts.require({ file: 'path_to_your_ts_file' });

// Use your module.
myTsModule.invokeAFunction();

Options object for require:

• file: 'path to your TS file'
• fileEncoding: ascii | utf-8 - Specify encoding of the TS file (default is utf-8)
• source: 'string containing your TS module'

Note that the file and source options are mutually exclusive.

Compile a TS module and write generated JavaScript to disk.

var ts = require('typescript-handler');
var compileResult = ts.compileToDisk({ file: 'path_to_your_ts_file' });

// Get the full path to the generated JS file via path member.
console.log('Full path to compiled JS file is: ' + compileResult.path);

// Or, load the module and use it as if you used the above require() call.
var importedModule = compiledResult.require();

Options object for compileToDisk

• file: 'path to TS file'
• fileEncoding: ascii | utf-8 - optional flag to provide external ts file encoding, if necessary.
• compiledPath: 'path to compiled JS file' - optional argument to specify the location of the generated JS file.
• source: 'string representation of your TS'
• deleteOnExit: true | false - Remove generated JS file (including any generated sub-folders). Default is true.

Note that the file and source options are mutually exclusive.