Add Docs

Author: ingalls

.github/workflows/doc.yml

@@ -0,0 +1,46 @@
+name: Documentation
+
+on:
+  push:
+    branches: ["master"]
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-node@v3
+        with:
+            node-version: 18
+            registry-url: https://registry.npmjs.org/
+      - name: npm install
+        run: npm install
+      - name: npm run doc
+        run: npm run doc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: './docs/'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+

.gitignore

@@ -1,3 +1,5 @@
+docs/
+
 # Logs
 logs
 *.log

generic.ts

@@ -12,7 +12,7 @@ import Pool from './lib/pool.js';
 
 export * from './lib/postgis.js'
 
-export function Param(param) {
+export function Param<T>(param?: T): T | null {
     if (param === undefined) {
         return null;
     } else {

package-lock.json

@@ -7,6 +7,7 @@
     "types": "./generic.ts",
     "scripts": {
         "lint": "eslint generic.ts lib/**.ts",
+        "doc": "typedoc",
         "build": "tsc --build"
     },
     "repository": {
@@ -40,6 +41,7 @@
         "pg-structure": "^7.15.0",
         "postgres": "^3.4.3",
         "turbo": "^1.11.3",
+        "typedoc": "^0.25.8",
         "wkx": "^0.5.0"
     }
 }

package.json

@@ -6,8 +6,8 @@
         "strict": true,
         "skipLibCheck": true,
         "module": "es2022",
-        "esModuleInterop": true,
         "target": "es2022",
+        "esModuleInterop": true,
         "noImplicitAny": false,
         "moduleResolution": "node",
         "sourceMap": true,
@@ -21,6 +21,6 @@
     },
     "include": [
         "generic.ts",
-        "lib/**/*"
+        "lib/*.ts"
     ]
 }