Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/deno_doc/mod.ts>doc

Documentation generator for Deno
Go to Latest
function doc
import { doc } from "https://deno.land/x/deno_doc@0.74.1/mod.ts";

Generate asynchronously an array of documentation nodes for the supplied module.

Example

import { doc } from "https://deno.land/x/deno_doc/mod.ts";

const entries = await doc("https://deno.land/std/fmt/colors.ts");

for (const entry of entries) {
  console.log(`name: ${entry.name} kind: ${entry.kind}`);
}

Parameters

specifier: string

The URL string of the specifier to document

optional
options: DocOptions = [UNSUPPORTED]

A set of options for generating the documentation

Returns

Promise<Array<DocNode>>

A promise that resolves with an array of documentation nodes