Github pages workflow

.github/workflows/ci.yaml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 jobs:
   "node-test":
     name: "Build and test on Node.js"
-    runs-on: "ubuntu-latest"
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         "node-version": ["14.x", "18.x"]

.github/workflows/pages.yaml

@@ -0,0 +1,43 @@
+name: "GitHub Pages"
+on:
+  push:
+    branches: ["main"]
+
+jobs:
+  "build":
+    name: "Build the docs"
+    runs-on: ubuntu-latest
+    steps:
+    - name: "Checkout this repo"
+      uses: actions/checkout@v3
+    - name: "Setup Node.js"
+      uses: actions/setup-node@v3
+      with:
+        node-version: "${{ matrix.node-version }}"
+        cache: "npm"
+    - name: "Install npm dependencies"
+      run: "npm ci"
+    - name: "Build"
+      run: "npm run typedoc"
+    - name: "Upload GitHub Pages artifact"
+      uses: actions/upload-pages-artifact@v1
+      with:
+        path: "./docs"
+
+  "deploy":
+    name: "Deploy the docs to GitHub Pages"
+    needs: "build"
+    permissions:
+        pages: write
+        id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Deploy to GitHub Pages"
+        id: deployment
+        uses: actions/deploy-pages@v1
+

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 /lib-esm
 /lib-cjs
+/docs
 *.tsbuildinfo
 Session.vim

package.json

@@ -43,7 +43,8 @@
     "clean-build": "npm run clean && npm run build",
 
     "typecheck": "tsc --noEmit",
-    "test": "jest"
+    "test": "jest",
+    "typedoc": "rm -rf ./docs && typedoc"
   },
 
   "dependencies": {
@@ -55,6 +56,7 @@
     "@types/jest": "^29.4.0",
     "jest": "^29.4.0",
     "ts-jest": "^29.0.5",
+    "typedoc": "^0.23.28",
     "typescript": "^4.9.4"
   }
 }

src/batch.ts

@@ -64,6 +64,7 @@ export class Batch {
 export class BatchStep {
     #batch: Batch;
     #conditions: Array<proto.BatchCond>;
+    /** @private */
     _index: number | undefined;
 
     /** @private */

src/errors.ts

@@ -2,6 +2,7 @@ import type * as proto from "./proto.js";
 
 /** Generic error produced by the Hrana client. */
 export class ClientError extends Error {
+    /** @private */
     constructor(message: string) {
         super(message);
         this.name = "ClientError";
@@ -10,6 +11,7 @@ export class ClientError extends Error {
 
 /** Error thrown when the server violates the protocol. */
 export class ProtoError extends ClientError {
+    /** @private */
     constructor(message: string) {
         super(message);
         this.name = "ProtoError";
@@ -18,8 +20,10 @@ export class ProtoError extends ClientError {
 
 /** Error thrown when the server returns an error response. */
 export class ResponseError extends ClientError {
+    /** @internal */
     proto: proto.Error
 
+    /** @private */
     constructor(message: string, protoError: proto.Error) {
         super(message);
         this.name = "ResponseError";
@@ -30,6 +34,7 @@ export class ResponseError extends ClientError {
 
 /** Error thrown when the client or stream is closed. */
 export class ClosedError extends ClientError {
+    /** @private */
     constructor(message: string, cause: Error) {
         super(message);
         this.cause = cause;

src/index.ts

@@ -6,12 +6,14 @@ import type * as proto from "./proto.js";
 export { Client } from "./client.js";
 export * from "./errors.js";
 export { Batch, BatchStep, BatchCond } from "./batch.js";
+/** @internal */
 export * as raw from "./raw.js";
 export type { StmtResult, RowsResult, RowResult, ValueResult, Row } from "./result.js";
 export type { InStmt, InStmtArgs } from "./stmt.js";
 export { Stmt } from "./stmt.js";
 export { Stream } from "./stream.js";
 export type { Value, InValue } from "./value.js";
+/** @internal */
 export type { proto };
 
 /** Open a Hrana client connected to the given `url`. */

typedoc.json

@@ -0,0 +1,10 @@
+{
+    "entryPoints": ["src/index.ts"],
+    "out": "docs",
+    "excludePrivate": true,
+    "excludeInternal": true,
+    "visibilityFilters": {
+        "inherited": true,
+        "external": true
+    }
+}