GitHub
Preparing search index...
The search index is not available
typedoc-theme-example - v1.1.3
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
typedoc-theme-example
ComplexGenericTypeAlias
Type alias ComplexGenericTypeAlias<T>
Complex
Generic
Type
Alias
<
T
>
:
T
|
T
[]
|
Promise
<
T
>
|
Promise
<
T
[]
>
|
Record
<
string
,
Promise
<
T
>
>
A complex generic type.
Type Parameters
T
typedoc-
theme-
example -
v1.1.3
Simple
Enum
Describes the status of a delivery order.
Crazy
Enum
A crazy enum from the TypeScript
Enum
Like
Object
Since TypeScript's `enum` can be inconvenient to work with, some packages define their own enum-like objects
Enum
Like
Object
Num
Values
Since TypeScript's `enum` can be inconvenient to work with, some packages define their own enum-like objects
Customer
An abstract base class for the customer entity in our application.
Delivery
Customer
A class that extends `Customer`.
String
Array
An array of strings that's defined as
Cancellable
Promise
This example shows off how TypeDoc handles
Make
Http
CallAOptions
The options type for makeHttpCallA.
User
A simple interface. Each property has its own doc comment.
Admin
User
An interface that extends `User` and adds more properties.
CardAProps
The props type for CardA.
Easy
Form
Dialog
Props
The props type of `EasyFormDialog`.
Simple
Type
Alias
A simple type alias defined using the `type` keyword.
Complex
Generic
Type
Alias
A complex generic type.
PI
A simple numeric constant.
STRING_
CONSTANT
A simple string constant.
Object
Constant
An plain JavaScript object using `as const`.
E
An exported variable defined with `let`.
sqrt
Calculates the square root of a number.
concat
A simple generic function that concatenates two arrays.
make
Http
CallA
A function that takes in an options object that is defined as a separate
make
Http
CallB
A function that takes in an options object and makes an HTTP call.
overloaded
Function
Stringifies and concatenates two numbers into a single string.
sqrt
Arrow
Function
Calculates the square root of a number. `sqrtArrowFunction` is defined using a variable declaration
lodash
Sort
By
Creates an array of elements, sorted in ascending order by the results of
markdown
Showcase
Markdown Showcase
syntax
Highlighting
Showcase
TypeDoc supports code blocks in Markdown and uses
CardA
Renders a card around some content.
CardB
Renders a card around some content.
Easy
Form
Dialog
An example of a complex React component.
an
Internal
Function
Use `@internal` to indicate that something is for internal use. If the `--excludeInternal` option is passed, TypeDoc will not document the given
Generated using
TypeDoc
A complex generic type.