RoadmapShopEvents
Skip to main content

Home > @microsoft/api-extractor-model > IApiVariableOptions

IApiVariableOptions interface

Constructor options for ApiVariable.

Signature:

export interface IApiVariableOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiReadonlyMixinOptions, IApiDeclaredItemOptions, IApiInitializerMixinOptions 

Extends: IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiReadonlyMixinOptions, IApiDeclaredItemOptions, IApiInitializerMixinOptions

Properties

PropertyModifiersTypeDescription
docCommenttsdoc.DocComment | undefined(Inherited from IApiDocumentedItemOptions)
excerptTokensIExcerptToken[](Inherited from IApiDeclaredItemOptions)
initializerTokenRange?IExcerptTokenRange

(Optional)

(Inherited from IApiInitializerMixinOptions)

isReadonlyboolean(Inherited from IApiReadonlyMixinOptions)
namestring(Inherited from IApiNameMixinOptions)
releaseTagReleaseTag(Inherited from IApiReleaseTagMixinOptions)
variableTypeTokenRangeIExcerptTokenRange