Scripting engine documentation

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

Build

Install documentation.js

npm install -g documentation

Generate html file

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

IntelliSense

There are Typescript Typings available which are generated out of the docs. You can use them e.g. in Visual Studio Code.

Visual Studio Code

First of all, you need to install these typings by executing: npm install sinusbot-scripting-engine or yarn add sinusbot-scripting-engine. Now you have the typings installed, to give the Typescript interpreter some parameters in, you need to create a jsconfig.json:

{
    "compilerOptions": {
        "target": "es5",
        "module": "commonjs"
    }
}

At this time, you are ready to go, just add // @ts-check at the first line of your script. This enables the type checking.

For reference, you can check out this repository, which is using these typings.