Rush StackShopBlogEvents
Skip to main content

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

IResolveDeclarationReferenceResult interface

Result object for ApiModel.resolveDeclarationReference().

Signature:

export interface IResolveDeclarationReferenceResult 

Properties

Property

Modifiers

Type

Description

errorMessage

string | undefined

If resolvedApiItem is undefined, then this will always contain an error message explaining why the resolution failed.

resolvedApiItem

ApiItem | undefined

The referenced ApiItem, if the declaration reference could be resolved.