Home > @microsoft/api-extractor-model

api-extractor-model package

Use this library to read and write *.api.json files as defined by the API Extractor tool. These files are used to generate a documentation website for your TypeScript package. The files store the API signatures and doc comments that were extracted from your package.

Classes

Class	Description
ApiCallSignature	Represents a TypeScript function call signature.
ApiClass	Represents a TypeScript class declaration.
ApiConstructor	Represents a TypeScript class constructor declaration that belongs to an ApiClass.
ApiConstructSignature	Represents a TypeScript construct signature that belongs to an ApiInterface.
ApiDeclaredItem	The base class for API items that have an associated source code excerpt containing a TypeScript declaration.
ApiDocumentedItem	An abstract base class for API declarations that can have an associated TSDoc comment.
ApiEntryPoint	Represents the entry point for an NPM package.
ApiEnum	Represents a TypeScript enum declaration.
ApiEnumMember	Represents a member of a TypeScript enum declaration.
ApiFunction	Represents a TypeScript function declaration.
ApiIndexSignature	Represents a TypeScript index signature.
ApiInterface	Represents a TypeScript class declaration.
ApiItem	The abstract base class for all members of an ApiModel object.
ApiMethod	Represents a TypeScript member function declaration that belongs to an ApiClass.
ApiMethodSignature	Represents a TypeScript member function declaration that belongs to an ApiInterface.
ApiModel	A serializable representation of a collection of API declarations.
ApiNamespace	Represents a TypeScript namespace declaration.
ApiPackage	Represents an NPM package containing API declarations.
ApiProperty	Represents a TypeScript property declaration that belongs to an ApiClass.
ApiPropertyItem	The abstract base class for ApiProperty and ApiPropertySignature.
ApiPropertySignature	Represents a TypeScript property declaration that belongs to an ApiInterface.
ApiTypeAlias	Represents a TypeScript type alias declaration.
ApiVariable	Represents a TypeScript variable declaration.
Excerpt	The Excerpt class is used by ApiDeclaredItem to represent a TypeScript code fragment that may be annotated with hyperlinks to declared types (and in the future, source code locations).
ExcerptToken	Represents a fragment of text belonging to an Excerpt object.
HeritageType	Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class or interface.
Parameter	Represents a named parameter for a function-like declaration.
SourceLocation	The source location where a given API item is declared.
TypeParameter	Represents a named type parameter for a generic declaration.

Enumerations

Enumeration	Description
ApiItemKind	The type returned by the ApiItem.kind property, which can be used to easily distinguish subclasses of ApiItem.
EnumMemberOrder	Options for customizing the sort order of ApiEnum members.
ExcerptTokenKind
FindApiItemsMessageId	Unique identifiers for messages returned as part of IFindApiItemsResult.
ReleaseTag	A "release tag" is a custom TSDoc tag that is applied to an API to communicate the level of support provided for third-party developers.

Functions

Function	Description
ApiAbstractMixin(baseClass)	Mixin function for ApiAbstractMixin.
ApiExportedMixin(baseClass)	Mixin function for ApiExportedMixin.
ApiInitializerMixin(baseClass)	Mixin function for ApiInitializerMixin.
ApiItemContainerMixin(baseClass)	Mixin function for ApiDeclaredItem.
ApiNameMixin(baseClass)	Mixin function for ApiNameMixin.
ApiOptionalMixin(baseClass)	Mixin function for ApiOptionalMixin.
ApiParameterListMixin(baseClass)	Mixin function for ApiParameterListMixin.
ApiProtectedMixin(baseClass)	Mixin function for ApiProtectedMixin.
ApiReadonlyMixin(baseClass)	Mixin function for ApiReadonlyMixin.
ApiReleaseTagMixin(baseClass)	Mixin function for ApiReleaseTagMixin.
ApiReturnTypeMixin(baseClass)	Mixin function for ApiReturnTypeMixin.
ApiStaticMixin(baseClass)	Mixin function for ApiStaticMixin.
ApiTypeParameterListMixin(baseClass)	Mixin function for ApiTypeParameterListMixin.

Interfaces

Interface	Description
ApiAbstractMixin	The mixin base class for API items that have an abstract modifier.
ApiExportedMixin	The mixin base class for API items that can be exported.
ApiInitializerMixin	The mixin base class for API items that can have an initializer.
ApiItemContainerMixin	The mixin base class for API items that act as containers for other child items.
ApiNameMixin	The mixin base class for API items that have a name. For example, a class has a name, but a class constructor does not.
ApiOptionalMixin	The mixin base class for API items that can be marked as optional by appending a ? to them. For example, a property of an interface can be optional.
ApiParameterListMixin	The mixin base class for API items that can have function parameters (but not necessarily a return value).
ApiProtectedMixin	The mixin base class for API items that can have the TypeScript protected keyword applied to them.
ApiReadonlyMixin	The mixin base class for API items that cannot be modified after instantiation. Examples such as the readonly modifier and only having a getter but no setter.
ApiReleaseTagMixin	The mixin base class for API items that can be attributed with a TSDoc tag such as @internal, @alpha, @beta, or @public. These "release tags" indicate the support level for an API.
ApiReturnTypeMixin	The mixin base class for API items that are functions that return a value.
ApiStaticMixin	The mixin base class for API items that can have the TypeScript static keyword applied to them.
ApiTypeParameterListMixin	The mixin base class for API items that can have type parameters.
IApiAbstractMixinOptions	Constructor options for ApiAbstractMixin.
IApiCallSignatureOptions	Constructor options for ApiCallSignature.
IApiClassOptions	Constructor options for ApiClass.
IApiConstructorOptions	Constructor options for ApiConstructor.
IApiConstructSignatureOptions	Constructor options for ApiConstructor.
IApiDeclaredItemOptions	Constructor options for ApiDeclaredItem.
IApiDocumentedItemOptions	Constructor options for ApiDocumentedItem.
IApiEntryPointOptions	Constructor options for ApiEntryPoint.
IApiEnumMemberOptions	Constructor options for ApiEnumMember.
IApiEnumOptions	Constructor options for ApiEnum.
IApiExportedMixinOptions	Constructor options for IApiExportedMixinOptions.
IApiFunctionOptions	Constructor options for ApiFunction.
IApiIndexSignatureOptions	Constructor options for ApiIndexSignature.
IApiInitializerMixinOptions	Constructor options for IApiInitializerMixinOptions.
IApiInterfaceOptions	Constructor options for ApiInterface.
IApiItemConstructor	This abstraction is used by the mixin pattern. It describes a class type that inherits from ApiItem.
IApiItemContainerMixinOptions	Constructor options for ApiItemContainerMixin.
IApiItemOptions	Constructor options for ApiItem.
IApiMethodOptions	Constructor options for ApiMethod.
IApiMethodSignatureOptions
IApiNameMixinOptions	Constructor options for IApiNameMixinOptions.
IApiNamespaceOptions	Constructor options for ApiClass.
IApiOptionalMixinOptions	Constructor options for IApiOptionalMixinOptions.
IApiPackageOptions	Constructor options for ApiPackage.
IApiPackageSaveOptions	Options for ApiPackage.saveToJsonFile().
IApiParameterListMixinOptions	Constructor options for ApiParameterListMixin.
IApiParameterOptions	Represents parameter information that is part of IApiParameterListMixinOptions
IApiPropertyItemOptions	Constructor options for ApiPropertyItem.
IApiPropertyOptions	Constructor options for ApiProperty.
IApiPropertySignatureOptions	Constructor options for ApiPropertySignature.
IApiProtectedMixinOptions	Constructor options for IApiProtectedMixinOptions.
IApiReadonlyMixinOptions	Constructor options for ApiReadonlyMixin.
IApiReleaseTagMixinOptions	Constructor options for ApiReleaseTagMixin.
IApiReturnTypeMixinOptions	Constructor options for ApiReturnTypeMixin.
IApiStaticMixinOptions	Constructor options for IApiStaticMixinOptions.
IApiTypeAliasOptions	Constructor options for ApiTypeAlias.
IApiTypeParameterListMixinOptions	Constructor options for ApiTypeParameterListMixin.
IApiTypeParameterOptions	Represents parameter information that is part of IApiTypeParameterListMixinOptions
IApiVariableOptions	Constructor options for ApiVariable.
IExcerptToken
IExcerptTokenRange	Used by Excerpt to indicate a range of indexes within an array of ExcerptToken objects.
IFindApiItemsMessage	This object is used for messages returned as part of IFindApiItemsResult.
IFindApiItemsResult	Generic result object for finding API items used by different kinds of find operations.
IParameterOptions	Constructor options for Parameter.
IResolveDeclarationReferenceResult	Result object for ApiModel.resolveDeclarationReference().
ISourceLocationOptions	Constructor options for SourceLocation.
ITypeParameterOptions	Constructor options for TypeParameter.

Namespaces

Namespace	Description
ApiAbstractMixin	Static members for ApiAbstractMixin.
ApiExportedMixin	Static members for ApiExportedMixin.
ApiInitializerMixin	Static members for ApiInitializerMixin.
ApiItemContainerMixin	Static members for ApiItemContainerMixin.
ApiNameMixin	Static members for ApiNameMixin.
ApiOptionalMixin	Optional members for ApiOptionalMixin.
ApiParameterListMixin	Static members for ApiParameterListMixin.
ApiProtectedMixin	Static members for ApiProtectedMixin.
ApiReadonlyMixin	Static members for ApiReadonlyMixin.
ApiReleaseTagMixin	Static members for ApiReleaseTagMixin.
ApiReturnTypeMixin	Static members for ApiReturnTypeMixin.
ApiStaticMixin	Static members for ApiStaticMixin.
ApiTypeParameterListMixin	Static members for ApiTypeParameterListMixin.
ReleaseTag	Helper functions for working with the ReleaseTag enum.

Type Aliases

Type Alias	Description
Constructor	This abstraction is used by the mixin pattern. It describes a class constructor.
PropertiesOf	This abstraction is used by the mixin pattern. It describes the "static side" of a class.