https://github.com/laurci/so-loader

https://github.com/laurci/so-loader

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/laurci/so-loader
• Owner: laurci
• Created: 2022-12-10T21:15:12.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-05-07T13:34:59.000Z (over 1 year ago)
• Last Synced: 2024-10-30T06:27:14.488Z (3 months ago)
• Language: TypeScript
• Size: 68.4 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# so-loader

**Disclaimer**: This is a work in progress. It's not ready for production use. I don't guarantee that I will finish this project.

This project is an auto-loader for FFIs. It only supports the `.so` format and the Linux OS.

Instead of having to manually write out the functions and types for functions, this library will automatically read the debug symfols from the `.so` file and generate the FFI for you.

## Setup

This library only supports the `.so` format and the Linux OS.

You also need to have `dwarfdump` installed. This is used to read the debug symbols from the `.so` file.

## Building and runnning

To build the project run `yarn build`. The outputs of the build will be available in the `dist` directory. To watch the source and build on change run `yarn build --watch`.

The project targets Node as it's runtime, so it's as easy as `node .` to run it. (This starts `dist/index.js`).