Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 2.62 KB

README.md

File metadata and controls

59 lines (34 loc) · 2.62 KB

hyperimport

⚡ TypeScript imports on steroids. Import C, Rust, Zig etc. files in your TypeScript code and more.

A powerful plugin for the Bun runtime that pushes the limits of Plugin and FFI APIs together, lets you easily import functions from other languages. It works with languages that support the C ABI (Zig, Rust, C/C++, C#, Nim, Kotlin, etc). If the loader of your language isn't there already, go ahead write your own custom loader with it's super flexible API and extend hyperimport to support your favorite language or even customize the built-in loaders to work in the way you want. Not just loaders but any plugin can be imported in hyperimport through it's own package management from hyperimport registry (our own community registry for bun plugins). See how.

Read the dev.to article for behind the scenes of this project.

In simple ways, you can do this,

index.ts

import { add } from "./add.rs";
console.log(add(5, 5)); // 10

add.rs

#[no_mangle]
pub extern "C" fn add(a: isize, b: isize) -> isize {
    a + b
}

and, more...

  • Write a TypeScript program using native C functions through libc. See how.
  • Import native system functions in typescript through system shared libraries.
  • Import any kind of bun plugin package from the hyperimport registry.
  • Your imagination is now your limit...

Showcases

  • Featured at official Bun 1.0 launch - Watch video
  • Importing a Rust function in typescript (@jarredsumner) - Watch video
  • Importing a Zig function in typescript (@jarredsumner) - Watch video
  • Walkthrough guide by the community - Watch video

Documentation

—"I wanna learn more about this! How do I get started?"

Check out the Wiki page of this repository to read the entire documentation for this project.

If you have any questions, feel free to join the discord server here.

License

This repository uses MIT license. See LICENSE for full license text.