Skip to content

[api-extractor] APIs defined via module augmentation not included in the report #2264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 task done
hiranya911 opened this issue Oct 7, 2020 · 0 comments
Open
1 task done

Comments

@hiranya911
Copy link
Contributor

Is this a feature or a bug?

  • Feature

This could potentially be a bug too

Please describe the actual behavior.

I'm re-exporting a type from another module with module augmentation.

import * as rtdb from '@firebase/database-types';

// Augment the FirebaseDatabase type
declare module '@firebase/database-types' {
  export interface FirebaseDatabase {
    getRules(): Promise<string>;
    getRulesJSON(): Promise<object>;
    setRules(source: string | Buffer | object): Promise<void>;
  }
}

// Re-export the augmented type
export namespace database {
  export import Database = rtdb.FirebaseDatabase;
}

The generated API reports (both the json file and the markdown file) do not mention any of the APIs added via augmentation.

What is the expected behavior?

APIs added via module augmentation should be included in the API report.

If this is a bug, please provide the tool version, Node.js version, and OS.

  • Tool: API Extractor
  • Tool Version: v7.10.4
  • Node Version: v10.22.0
    • Is this a LTS version? Yes
  • OS: Mac

Potentially related: #2145, #1709

@github-project-automation github-project-automation bot moved this to Needs triage in Bug Triage Feb 26, 2024
@iclanton iclanton moved this from Needs triage to AE/AD in Bug Triage Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: AE/AD
Development

No branches or pull requests

1 participant