docs?

Author: justjake

package.json

@@ -17,9 +17,9 @@
     "make-release": "make clean && make -j 8",
     "clean": "make clean",
     "build": "tsc",
-    "test": "mocha",
-    "watch": "tsc --watch",
-    "prettier": "prettier --write ./package.json ./**/*.ts",
+    "doc": "typedoc --plugin typedoc-plugin-markdown",
+    "test": "yarn make-debug && mocha",
+    "prettier": "prettier --write ./*.json ./**/*.ts ./*.js",
     "run-ts": "yarn make-debug && ts-node -T ./ts/examples/hello.ts",
     "run-n": "yarn make-debug && ./build/wrapper/native/test.exe"
   },
@@ -31,6 +31,8 @@
     "prettier": "^1.19.1",
     "source-map-support": "^0.5.16",
     "ts-node": "^8.5.4",
+    "typedoc": "^0.15.8",
+    "typedoc-plugin-markdown": "^2.2.16",
     "typescript": "^3.7.4"
   }
 }

ts/examples/hello.ts

@@ -16,8 +16,14 @@ import {
 } from './types'
 
 let isReady = false
+
 const QuickJSModule = QuickJSModuleLoader()
-export const ready = new Promise(resolve => {
+
+/**
+ * This promise will be fufilled when the QuickJS emscripten module has initialized
+ * and the {@link QuickJS} instance can be created.
+ */
+const ready = new Promise(resolve => {
   QuickJSModule.onRuntimeInitialized = resolve
 }).then(() => {
   isReady = true
@@ -68,6 +74,16 @@ class Lifetime<T, Owner = never> {
   }
 }
 
+/**
+ * QuickJSVm wraps a QuickJS Javascript runtime (JSRuntime*) and context (JSContext*).
+ * This class's methods return {@link QuickJSHandle}, which wrap C pointers (JSValue*).
+ * It's the caller's responsibility to call {@link QuickJSHandle#dispose} on any
+ * handles you create to free memory once you're done with the handle.
+ *
+ * You cannot share handles between different QuickJSVm instances.
+ *
+ * @see {@link QuickJS#createVm} Creates a new QuickJSVm
+ */
 export class QuickJSVm implements LowLevelJavascriptVm<QuickJSHandle> {
   readonly ctx: Lifetime<JSContextPointer>
   readonly rt: Lifetime<JSRuntimePointer>
@@ -101,6 +117,10 @@ export class QuickJSVm implements LowLevelJavascriptVm<QuickJSHandle> {
     return (this._undefined = new Lifetime(ptr))
   }
 
+  /**
+   * A handle to the global object inside the interpreter.
+   * You can set properties to create global variables.
+   */
   get global() {
     if (this._global) {
       return this._global
@@ -305,6 +325,11 @@ export class QuickJSVm implements LowLevelJavascriptVm<QuickJSHandle> {
     return result.value
   }
 
+  /**
+   * Dispose of this VM's underlying resources.
+   * Calling this method without disposing of all created handles will result
+   * in an error.
+   */
   dispose() {
     for (const lifetime of this.lifetimes) {
       if (lifetime.alive) {
@@ -318,6 +343,9 @@ export class QuickJSVm implements LowLevelJavascriptVm<QuickJSHandle> {
   private fnNextId = 0
   private fnMap = new Map<number, VmFunctionImplementation<QuickJSHandle>>()
 
+  /**
+   * @private
+   */
   cToHostCallbackFunction: CToHostCallbackFunctionImplementation = (
     ctx,
     this_ptr,
@@ -449,6 +477,14 @@ export type QuickJSHandle = StaticJSValue | JSValue | JSValueConst
 /**
  * QuickJS presents a Javascript interface to QuickJS, a Javascript interpreter that
  * supports ES2019.
+ *
+ * QuickJS is a singleton. Use the {@link getInstance} function to instantiate
+ * or retrieve an instance.
+ *
+ * Use the {@link QuickJS#createVm} method to create a {@link QuickJSVm}.
+ *
+ * Use the {@link QuickJS#evalCode} method as a shortcut evaluate Javascript safely
+ * and return the result as a native Javascript value.
  */
 export class QuickJS {
   private ffi = new QuickJSFFI(QuickJSModule)
@@ -512,6 +548,8 @@ export class QuickJS {
 
   /**
    * One-off evaluate code without needing to create a VM.
+   * The result is coerced to a native Javascript value using JSON
+   * serialization, so values unsupported by JSON will be dropped.
    */
   evalCode(code: string): unknown {
     const vm = this.createVm()

ts/quickjs.ts

@@ -1,21 +1,27 @@
 {
-  "include": ["ts/**/*.ts", "ts/**/*.js", "build/wrapper/**/*.js", "build/wrapper/**/*.wasm", "build/wrapper/**/*.ts"],
+  "include": [
+    "ts/**/*.ts",
+    "ts/**/*.js",
+    "build/wrapper/**/*.js",
+    "build/wrapper/**/*.wasm",
+    "build/wrapper/**/*.ts"
+  ],
   "exclude": ["node_modules"],
   "compilerOptions": {
     /* Basic Options */
-    "incremental": true,                   /* Enable incremental compilation */
-    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "incremental": true /* Enable incremental compilation */,
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
 
-    "lib": ["es2015", "dom"],                             /* Specify library files to be included in the compilation. */
-    "allowJs": true,                       /* Allow javascript files to be compiled. */
+    "lib": ["es2015", "dom"] /* Specify library files to be included in the compilation. */,
+    "allowJs": true /* Allow javascript files to be compiled. */,
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
     // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    "sourceMap": true /* Generates corresponding '.map' file. */,
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./build/js",                        /* Redirect output structure to the directory. */
+    "outDir": "./build/js" /* Redirect output structure to the directory. */,
     // "composite": true,                     /* Enable project compilation */
     // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
     // "removeComments": true,                /* Do not emit comments to output. */
@@ -25,7 +31,7 @@
     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
     /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
+    "strict": true /* Enable all strict type-checking options. */,
     // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
     // "strictNullChecks": true,              /* Enable strict null checks. */
     // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
@@ -35,23 +41,23 @@
     // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
 
     /* Additional Checks */
-    "noUnusedLocals": true,                /* Report errors on unused locals. */
+    "noUnusedLocals": true /* Report errors on unused locals. */,
     // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
+    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
 
     /* Module Resolution Options */
-    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
     // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     "typeRoots": [
       "node_modules/@types",
-      "./node_modules/@snyk/types-tap",
-    ],                       /* List of folders to include type definitions from. */
+      "./node_modules/@snyk/types-tap"
+    ] /* List of folders to include type definitions from. */,
     // "types": [],                           /* Type declaration files to be included in compilation. */
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
     // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
 
@@ -66,6 +72,6 @@
     // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
 
     /* Advanced Options */
-    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
   }
 }

tsconfig.json

@@ -0,0 +1,20 @@
+const NO_THANKS = ['**/node_modules/**', './quickjs/**']
+
+function escapeEntrypoint(str) {
+  const wanted = 1
+  let out = str
+  for (let i = 0; i < wanted; i++) {
+    out = JSON.stringify(out)
+  }
+  return out
+}
+
+module.exports = {
+  out: './doc',
+  //entryPoint: escapeEntrypoint('ts/quickjs'),
+  exclude: NO_THANKS,
+  externalsPattern: NO_THANKS[0],
+  excludeNotExported: true,
+  excludePrivate: true,
+  ignoreCompilerErrors: true,
+}