APIReference
Displays type documentation for all types exported from a file path or types related to a collection export source.
API Reference
APIReference
(props: APIReferenceProps) => JSX.ElementDisplays type documentation for all types exported from a file path or types related to a collection export source.
Parameters
APIReferencePropsReturns
ElementAPIReferenceProps
APIReferencePropsProperties
source *
stringThe file path to the source code.
workingDirectory
string | undefinedThe working directory to resolve the file path from. Will use the base URL if a URL is provided.
filter
SymbolFilter | undefinedA filter to apply to the exported types.
Properties
source *
ExportSource<any> | FileSystemSource<any> | JavaScriptFile<any> | JavaScriptFileExport<any, ExtensionType, string>The export source from a collection export source to get types from.
filter
SymbolFilter | undefinedA filter to apply to the exported types.
Last updated