XXXX, defined at XXXXX.ts:5, is referenced by XXX but not included in the documentation.

See original GitHub issue

Search terms

“XXXX, defined at XXXXX.ts:5, is referenced by XXX but not included in the documentation.”

Question

I have the warning :

Warning: IController, defined at src\IController.ts:5, is referenced by Controller but not included in the documentation.

The file Controller is here : https://github.com/thib3113/unifi-client/blob/main/src/Controller.ts

And I doesn’t understand why … The interface is correctly exported (not default), correctly imported in Controller … And finally seems to be included in documentation : https://thib3113.github.io/unifi-client/interfaces/IController.html . ( the documentation page of the Controller : https://thib3113.github.io/unifi-client/classes/Controller.html ) .

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:5

github_iconTop GitHub Comments

1reaction
Gerrit0commented, Sep 12, 2021

I fully thought this was a bug for a few minutes!

You do have an export called IController, but it isn’t the IController which Controller implements.

The IController that is documented is defined at src/WebSockets/Interfaces.ts:104 The IController that the Controller class is referencing is defined at src/IController.ts:6

I’m not sure what the proper fix for this one is going to be for your library, if you export the IController from src/IController, then you’ll get a different warning due to ISystemEvent.apps, which references the other IController

0reactions
thib3113commented, Sep 18, 2021

@carltian in my case, I have two interfaces with the same name, and only one is exported at the root level … So I rename one of the two, and export the two …

Read more comments on GitHub >

github_iconTop Results From Across the Web

Xxxxxxx.xxx Software Product Definition - Law Insider
xxx Software Product means certain computer programs including the LindowsOS(TM) and related documentation and interface specifications developed, owned, ...
Read more >
0001193125-18-315644.txt - SEC.gov
The SEC registered securities described herein are not bank deposits but are senior, unsecured debt obligations of Citi. All returns and any principal ......
Read more >
Reference for Oracle GoldenGate
This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation ...
Read more >
Diff: draft-ietf-nvo3-arch-07.txt - draft-ietf-nvo3-arch-08.txt
Internet-Drafts are draft documents valid for a maximum of six months and may ... as described in Section 4.e of the Trust Legal...
Read more >
IBM Tivoli Monitoring: Troubleshooting Guide
An agent does not display in the portal client or in the output from the listSystems command. . . . 240. One monitoring...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found