https://github.com/radarsu/ts-import

Importing TypeScript files dynamically into JavaScript requires additional compilation step, which is troublesome to write for many. Popular typescript-require package seems to be obsolete and doesn't allow much customization.
https://github.com/radarsu/ts-import

compile dynamic import require typescript

Last synced: about 1 year ago
JSON representation

Importing TypeScript files dynamically into JavaScript requires additional compilation step, which is troublesome to write for many. Popular typescript-require package seems to be obsolete and doesn't allow much customization.

• Host: GitHub
• URL: https://github.com/radarsu/ts-import
• Owner: radarsu
• License: mit
• Created: 2020-07-06T13:55:14.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2025-02-19T11:44:28.000Z (about 1 year ago)
• Last Synced: 2025-03-28T19:11:18.581Z (about 1 year ago)
• Topics: compile, dynamic, import, require, typescript
• Language: TypeScript
• Homepage:
• Size: 28.3 KB
• Stars: 53
• Watchers: 3
• Forks: 9
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    
ts-import

    
Importing TypeScript files dynamically into JavaScript requires additional compilation step, which is troublesome to write for many. Popular `typescript-require` package seems to be obsolete and doesn't allow much customization. Typed alternative to https://github.com/theblacksmith/typescript-require written in TypeScript.


[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/radarsu)

## Table of contents

- [Table of contents](#table-of-contents)

- [Features](#features)

- [Install](#install)

- [Usage](#usage)

  - [allowConfigurationWithComments](#allowconfigurationwithcomments)

## Features

-   **Asynchronous and synchronous version** - uses **import** for async and **require** for sync.

-   **Caches JavaScript** files into directory inside **.cache/ts-import**.

-   **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). Also, compilation in versions 3+ is approximately 10x faster than in version 2.

-   **Few dependencies** - uses only `comment-parser` and my tiny utility package `options-defaults`.

-   **Highly flexible and configurable** - all compilerOptions are available under transpileOptions parameter.

-   **No interference** - doesn't interfere with native import, require etc. changing their behavior or impacting their performance.

## Install

`npm i ts-import@4` - CJS

`npm i ts-import@5` - ESM

## Usage

```ts

import * as tsImport from 'ts-import';

const main = async () => {

    const filePath = `/home/user/file.ts`;

    const asyncResult = await tsImport.load(filePath, {

        // allowConfigurationWithComments: false,

    });

    // Only available in version 4.

    const syncResult = tsImport.loadSync(filePath);

};

void main();

```

### allowConfigurationWithComments

You can define if file should be imported in the default `transpile` mode or `compile` mode by placing a comment on top of the specific file.

Compile mode is slower, but allows the specified file to be part of a complex program - it can import other files etc.

```ts

/**

 * @tsImport

 * { "mode": "compile" }

 */

import { getOtherVariable } from './get-other-variable';

const result = getOtherVariable();

export { result };

```