Skip to content

ExportDeclaration

Represents an exported declaration with metadata including file path, symbol name, and JSDoc information.

Signature

typescript
type ExportDeclaration = {
  filePath: StandardizedFilePath;
  symbolName: string;
  declaration: ExportedDeclarations;
  kind: DeclarationKind;
  jsDoc: JSDoc;
  signature: string;
};

Parameters

  • filePathRequired · StandardizedFilePath

    Standardized file path of the exported declaration

  • symbolNameRequired · string

    Symbol name of the exported declaration

  • declarationRequired · ExportedDeclarations

    TypeScript declaration object

  • kindRequired · DeclarationKind

    Type of the declaration

  • jsDocRequired · JSDoc

    Raw JSDoc data

  • signatureRequired · string

    TypeScript signature string

Released under the MIT License.