Documentation Generator Types

Since 1.8.0

Type-level documentation generation.

Documentation Core

Documentation

Documentation structure definition.

import type { Documentation } from 'uni-types'

type Docs = Documentation<string>

DocEntry

Documentation entry type.

import type { DocEntry } from 'uni-types'

type Entry = DocEntry<string>
// { id: string; name: string; kind: DocEntryKind; description?: string; ... }

DocSection

Documentation section type.

import type { DocSection } from 'uni-types'

type Section = DocSection<string>

DocPage

Documentation page definition.

import type { DocPage } from 'uni-types'

type Page = DocPage<string>

JSDoc Types

JSDoc

JSDoc definition.

import type { JSDoc } from 'uni-types'

type Doc = JSDoc<string>

JSDocTag

JSDoc tag types.

import type { JSDocTag } from 'uni-types'

type Tag = JSDocTag<string>
// { name: 'param'; content: JSDocParam } | { name: 'returns'; content: JSDocReturn } | ...

JSDocParam

JSDoc parameter type.

import type { JSDocParam } from 'uni-types'

type Param = JSDocParam
// { name: string; type?: string; description?: string; optional?: boolean; ... }

API Documentation

APIDoc

API documentation definition.

import type { APIDoc } from 'uni-types'

type API = APIDoc<string>

APIEndpoint

API endpoint type.

import type { APIEndpoint } from 'uni-types'

type Endpoint = APIEndpoint<string>

APIParameter

API parameter definition.

import type { APIParameter } from 'uni-types'

type Param = APIParameter<string>

APIResponse

API response type.

import type { APIResponse } from 'uni-types'

type Response = APIResponse<string>

Type Documentation

TypeDoc

Type documentation definition.

import type { TypeDoc } from 'uni-types'

type Doc = TypeDoc<string>

TypeDocProperty

Type property documentation.

import type { TypeDocProperty } from 'uni-types'

type Prop = TypeDocProperty<string>

TypeDocMethod

Type method documentation.

import type { TypeDocMethod } from 'uni-types'

type Method = TypeDocMethod<string>

Documentation Output

DocOutput

Documentation output definition.

import type { DocOutput } from 'uni-types'

type Output = DocOutput<string>

DocFormat

Documentation format types.

import type { DocFormat } from 'uni-types'

type Format = DocFormat  // 'markdown' | 'html' | 'json' | 'yaml' | 'pdf' | ...

Documentation Search

DocSearch

Documentation search definition.

import type { DocSearch } from 'uni-types'

type Search = DocSearch<string>

SearchResult

Search result type.

import type { SearchResult } from 'uni-types'

type Result = SearchResult<string>

SearchIndex

Search index definition.

import type { SearchIndex } from 'uni-types'

type Index = SearchIndex

Documentation Navigation

DocNavigation

Documentation navigation structure.

import type { DocNavigation } from 'uni-types'

type Nav = DocNavigation<string>

DocSidebar

Sidebar definition.

import type { DocSidebar } from 'uni-types'

type Sidebar = DocSidebar<string>

DocBreadcrumb

Breadcrumb type.

import type { DocBreadcrumb } from 'uni-types'

type Crumb = DocBreadcrumb