Deno Doc Components

DocBlock Component Showcase

DocBlockClass

Examples

Example 1

import { ByteSliceStream } from "https://deno.land/std@$STD_VERSION/streams/buffer.ts";
const response = await fetch("https://example.com");
const rangedStream = response.body!
  .pipeThrough(new ByteSliceStream(3, 8));

hello world

more body text

import { ByteSliceStream } from "https://deno.land/std@$STD_VERSION/streams/buffer.ts";
const response = await fetch("https://example.com");
const rangedStream = response.body!
  .pipeThrough(new ByteSliceStream(3, 8));

Constructors

new
AClass(a: string)

Some sort of doc here. love it

Type Parameters

T extends string

Properties

protected
readonly
deprecated
prop1: string

some property JSDoc

other: string
optional
someNumber: number
readonly
value: string

Static Methods

optional
stringify(value: unknown)

some js doc for the method

DocBlockEnum

Members

Array = "array"
String = "string"

Enum member with JSDoc.

DocBlockInterface

Type Parameters

T extends string

Index Signatures

[property]: string

Call Signatures

deprecated
<U extends string>(a: T): void

some doc here

Properties

readonly
prop1: string

Some prop JSDoc

Methods

getter
a(value: string): void
optional
deprecated
aMethod(a?: number): Thingy<T>

some markdown

DocBlockFn

overload one

Parameters

b: string

Returns

string

overload two

Parameters

b: number

a param doc

Returns

number

DocNodeTypeAlias

Type Parameters

V

the value of the record

definition: Record<string, V>

DocBlockNamespace

Classes

c
AClass
deprecated

a deprecated class

Enums

Functions

f
a

overload one

Interfaces

Type Aliases

some sort of type alias