Skip to main content
Module

x/apiland/docs.ts

The API server for deno.land
Go to Latest
import * as apiland from "https://deno.land/x/apiland@1.2.0/docs.ts";

Functions related to documenting modules.

Functions

Recursively add doc nodes to the mutations, serializing the definition fields and breaking out namespace entries as their own entities.

Given a set of doc nodes, commit them to the datastore.

If the descendent isn't a direct child of the parent, the Key of the parent is returned. If the descendent is a direct child of the parent, undefined is returned. If the provided key is not a descendent of the parent, the function throws.

Take a datastore entity and convert it to a DocPage. It will attempt to deserializes doc nodes for those pages that serialize them.

Given a module and version, attempt to resolve an import map specifier from a Deno configuration file. If none can be resolved, undefined is resolved.

Determines if a file path can be doc'ed or not.

Determine if a datastore key is equal to another one.

Namespaces and interfaces are open ended. This function will merge these together, so that you have single entries per symbol.

Query the datastore for doc nodes, deserializing the definitions and recursively querying namespaces.

Interfaces

Used only in APIland to represent a module without any exported symbols in the datastore.