Documentation

WSi4 TypeScript library

This directory contains the WSi4 API library written in TypeScript.

It is compiled into JavaScript and included as a resource for scripts that use JavaScript. Scripts that use TypeScript directly should simply include the files in here directly and compile via TypeScript.

Every TypeScript file in this directory must start with one of the following prefixes, followed by a _.

  • src/backend_*: Modules used by the backend, mainly its DocumentGraphHandler class

  • src/backend_hooks_*: Hooks used by DocumentGraphHandler before or after calling a future

  • src/cli_*: Modules used by the cli component

  • src/export_*: Modules used for exporting projects

  • src/gui_*: Modules used in WSi4' gui component

  • lib/*: General purpose library modules. These modules' declaration files and documentation is deployed to end users!

  • lib/ui_*: Modules for user interaction with WSi4's data structures usable in both gui and cli mode, like inserting a GraphNode

Generated using TypeDoc