ts-import

ts-import

Import (compile and cache on the fly) TypeScript files dynamically with ease.

Table of contents

1. Pre Requirements

2. Getting Started

3. Usage

4. Features

Pre Requirements

• Globally available tsc command (npm i -g typescript)

Getting Started

npm i ts-import

Usage

import { tsImport } from 'ts-import';

const bootstrap = async () => {
    const filePath = `/home/user/file.ts`;
    const compiled = await tsImport.compile(filePath);
};

bootstrap();

Features

• Caches JavaScript files into directory inside node_modules/ts-import/cache (pretty much like typescript-require). Removing module removes cache as well.
• Fast - I've benchmarked ways to compare detecting file changes with fs module and checking mtimeMs turned out to be fastest (https://jsperf.com/fs-stat-mtime-vs-mtimems).
• Asynchronous - uses import over require therefore is asynchronous.
• Highly flexible and configurable - all tsc flags are available for customization. By default uses: --module commonjs, --target es2015, --downlevelIteration, --emitDecoratorMetadata, --experimentalDecorators, --resolveJsonModule which allow greatest amount of features.
• Compiler class - allows making multiple instances of compiler with different configurations and overriding default settings to all of them (i.e. logger) via static "defaults" property: Compiler.defaults = { ...customDefaults }. tsImport object is a default instance of Compiler class suitable for majority of use-cases.
• No interference - doesn't interfere with native import, require etc. changing their behavior or impacting their performance.