Skip to content

Commit 914cc7e

Browse files
committed
Add doc comment example for ApiTypeAlias.aliasTypeExcerpt
1 parent c20db74 commit 914cc7e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

apps/api-extractor-model/src/model/ApiTypeAlias.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,14 @@ export interface IApiTypeAliasJson extends
5656
export class ApiTypeAlias extends ApiTypeParameterListMixin(ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredItem))) {
5757
/**
5858
* An {@link Excerpt} that describes the type of the alias.
59+
*
60+
* @remarks
61+
* In the example below, the `aliasTypeExcerpt` would correspond to the subexpression
62+
* `T extends any[] ? BoxedArray<T[number]> : BoxedValue<T>;`:
63+
*
64+
* ```ts
65+
* export type Boxed<T> = T extends any[] ? BoxedArray<T[number]> : BoxedValue<T>;
66+
* ```
5967
*/
6068
public readonly aliasTypeExcerpt: Excerpt;
6169

0 commit comments

Comments
 (0)