This repository contains the JSDoc based javascript file from which the scripting engine documentation is generated.

npm install -g documentation

documentation build api.js --project-name "SinusBot Scripting Engine" -f html -o documentation

There are TypeScript typings available which are generated out of the documentation. You can use them in IDEs like Visual Studio Code.

First of all you need to install the typings by executing: npm i sinusbot-scripting-engine or yarn add sinusbot-scripting-engine.

After you have the typings installed, you need to create a jsconfig.json with the following content:

{
    "compilerOptions": {
        "target": "es5",
        "checkJs": true
    }
}

Or alternatively if you only want to enable type checking for specific files set the config to

{
    "compilerOptions": {
        "target": "es5"
    }
}

and add // @ts-check as the first line of your script that should be checked.

For reference, you can check out this repository.