RoadmapShopEvents
Skip to main content

Home > @microsoft/api-documenter > IFeatureDefinition

IFeatureDefinition interface

Defines a "feature" that is provided by an API Documenter plugin. A feature is a user-defined module that customizes the behavior of API Documenter.

Signature:

export interface IFeatureDefinition 

Properties

PropertyModifiersTypeDescription
featureNamestring

The name of this feature, as it will appear in the config file.

The name should consist of one or more words separated by hyphens. Each word should consist of lower case letters and numbers. Example: my-feature

kind'MarkdownDocumenterFeature'Determines the kind of feature. The specified value is the name of the base class that subclass inherits from.
subclass{ new (initialization: PluginFeatureInitialization): MarkdownDocumenterFeature; }Your subclass that extends from the base class.