README.md

QuickJS Types

TypeScript definitions for the QuickJS Engine!

 

Usage

Node

Add using a package manager, e.g.: npm

npm i -D quickjs-types

Add types to tsconfig.json:

{
  "compilerOptions": {
    "types": ["quickjs-types"]
  }
}

Git Submodule

Add a submodule to a project, e.g. types/quickjs:

git submodule add [email protected]:mgred/quickjs-types.git types/quickjs

Extend tsconfig.json to use types:

{
  "compilerOptions": {
    "typeRoots": ["types"]
  }
}

Tests

All tests live in test.ts. To verify everyting passes, run:

tsc -p .

License

Code in this repository is licensed under the GNU General Public License v3

Todos

• Add more tests
• Add more documentation (comments)