Documentation Generation

Prim+RPC includes tools to generate RPC-specific documentation. It does this by reusing your existing TypeDoc documentation for your TypeScript or JavaScript code and converts this into a simpler version that documents functions as it relates to RPC.

The first step is to generate TypeDoc documentation for your code. This can be done by running the following command in your project:

npx typedoc src/index.ts --json dist/docs.json

Now you may execute this utility on the result:

import { createDocsForModule } from "@doseofted/prim-rpc-tooling/docs"
import typeDoc from "./dist/docs.json"
 
const rpcDocs = createDocsForModule(typeDoc)

The resulting documentation is a simpler version of the TypeDoc that relates to RPC. This output could be used for a documentation website or fed to another tool like HTTPsnippet to generate requests for other clients outside of JavaScript.