Preparing search index...
The search index is not available

TypeDoc Example - v1.1.7

Settings

Member Visibility

Protected
Inherited
External

Theme

TypeDoc Example
ComplexGenericTypeAlias

Type Alias ComplexGenericTypeAlias<T>

ComplexGenericTypeAlias<T>:
    | T
    | T[]
    | Promise<T>
    | Promise<T[]>
    | Record<string, Promise<T>>

A complex generic type.

Type Parameters

T

Defined in example/src/types.ts:5

TypeDoc Example - v1.1.7

External Markdown
Markdown Showcase
Syntax Highlighting
SimpleEnum
Describes the status of a delivery order.
CrazyEnum
A crazy enum from the TypeScript
EnumLikeObject
Since TypeScript's `enum` can be inconvenient to work with, some packages define their own enum-like objects
EnumLikeObjectNumValues
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.
DeliveryCustomer
A class that extends `Customer`.
StringArray
An array of strings that's defined as
CancellablePromise
This example shows off how TypeDoc handles
MakeHttpCallAOptions
The options type for makeHttpCallA.
User
A simple interface. Each property has its own doc comment.
AdminUser
An interface that extends `User` and adds more properties.
CardAProps
The props type for CardA.
EasyFormDialogProps
The props type of `EasyFormDialog`.
SimpleTypeAlias
A simple type alias defined using the `type` keyword.
ComplexGenericTypeAlias
A complex generic type.
PI
A simple numeric constant.
STRING_CONSTANT
A simple string constant.
ObjectConstant
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.
makeHttpCallA
A function that takes in an options object that is defined as a separate
makeHttpCallB
A function that takes in an options object and makes an HTTP call.
overloadedFunction
Stringifies and concatenates two numbers into a single string.
sqrtArrowFunction
Calculates the square root of a number. `sqrtArrowFunction` is defined using a variable declaration
lodashSortBy
Creates an array of elements, sorted in ascending order by the results of
CardA
Renders a card around some content.
CardB
Renders a card around some content.
EasyFormDialog
An example of a complex React component.
anInternalFunction
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