type alias DenoDocDeclaration

A single declaration of an exported symbol in deno doc --json output.

Properties

kind: string

Declaration kind, e.g. function, variable, interface.

location: { filename: string; }

Where the declaration lives; the version rides along for JSR specifiers.

optional
jsDoc: { doc?: string; }

The declaration's JSDoc, when it has one.

def: { params?: DenoDocParam[]; returnType?: DenoDocType; }

Kind-specific detail; for functions, the signature.

Usage

import { type DenoDocDeclaration } from "mod.ts";